aws-sdk-appstream 1.36.0 → 1.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: faecbf65bfbf67db0ce5bb6374adf70e8b3e3c4b
4
- data.tar.gz: 2769e6c6061c4b6cae745ca488693fab4b7a5ea5
2
+ SHA256:
3
+ metadata.gz: e0d77bfda293acb20be05dabf99e6fb0481468ac7a20dfe43188eeb895a3112c
4
+ data.tar.gz: b696dd5dabb740d508660893c097bcdd6fc07195ef858e28cf89b012810e80ad
5
5
  SHA512:
6
- metadata.gz: 718fa729eea55189d4da7f1e854cab9150690dd29e9c62c6965923fa6a15e703b27539cd13a85f237ea39d2ace1b6be59fb24ad117c3b61289f3306dd37095f5
7
- data.tar.gz: c3199336613b15d480330fb28c8c7ee7ceebe06f78e4d5b6a4ca24e45e1fa9e28438dc848fa3b281a3bd4a52c8c91c6f989ba4198777ee9af0a20e151f01d26a
6
+ metadata.gz: 3503efb17edc1121c86253232fe571d7a6601382222895140bb0fd371eabc8c2ee56753c35a1df7c3e4aa3f06bf60ddba93d737bac386c082063d6c9f4fbb5b9
7
+ data.tar.gz: e10a0ce1d047e14ddd5846b558673fdf753e08ce50194ed3e114f01e02ad9d56efff3cd990a4d0ed56d3143c5d094e5de6141f70c9856c25d792c387a949aae2
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-appstream/customizations'
25
25
  # methods each accept a hash of request parameters and return a response
26
26
  # structure.
27
27
  #
28
+ # app_stream = Aws::AppStream::Client.new
29
+ # resp = app_stream.associate_fleet(params)
30
+ #
28
31
  # See {Client} for more information.
29
32
  #
30
33
  # # Errors
31
34
  #
32
- # Errors returned from Amazon AppStream all
33
- # extend {Errors::ServiceError}.
35
+ # Errors returned from Amazon AppStream are defined in the
36
+ # {Errors} module and all extend {Errors::ServiceError}.
34
37
  #
35
38
  # begin
36
39
  # # do stuff
37
40
  # rescue Aws::AppStream::Errors::ServiceError
38
- # # rescues all service API errors
41
+ # # rescues all Amazon AppStream API errors
39
42
  # end
40
43
  #
41
44
  # See {Errors} for more information.
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-appstream/customizations'
43
46
  # @service
44
47
  module Aws::AppStream
45
48
 
46
- GEM_VERSION = '1.36.0'
49
+ GEM_VERSION = '1.41.0'
47
50
 
48
51
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:appstream)
31
31
 
32
32
  module Aws::AppStream
33
+ # An API client for AppStream. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::AppStream::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::AppStream
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::AppStream
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::AppStream
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::AppStream
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::AppStream
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::AppStream
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::AppStream
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::AppStream
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::AppStream
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -630,7 +684,17 @@ module Aws::AppStream
630
684
  # To assume a role, a fleet instance calls the AWS Security Token
631
685
  # Service (STS) `AssumeRole` API operation and passes the ARN of the
632
686
  # role to use. The operation creates a new session with temporary
633
- # credentials.
687
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
688
+ # creates the **AppStream\_Machine\_Role** credential profile on the
689
+ # instance.
690
+ #
691
+ # For more information, see [Using an IAM Role to Grant Permissions to
692
+ # Applications and Scripts Running on AppStream 2.0 Streaming
693
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
694
+ #
695
+ #
696
+ #
697
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
634
698
  #
635
699
  # @return [Types::CreateFleetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
636
700
  #
@@ -723,7 +787,48 @@ module Aws::AppStream
723
787
  # The ARN of the public, private, or shared image to use.
724
788
  #
725
789
  # @option params [required, String] :instance_type
726
- # The instance type to use when launching the image builder.
790
+ # The instance type to use when launching the image builder. The
791
+ # following instance types are available:
792
+ #
793
+ # * stream.standard.medium
794
+ #
795
+ # * stream.standard.large
796
+ #
797
+ # * stream.compute.large
798
+ #
799
+ # * stream.compute.xlarge
800
+ #
801
+ # * stream.compute.2xlarge
802
+ #
803
+ # * stream.compute.4xlarge
804
+ #
805
+ # * stream.compute.8xlarge
806
+ #
807
+ # * stream.memory.large
808
+ #
809
+ # * stream.memory.xlarge
810
+ #
811
+ # * stream.memory.2xlarge
812
+ #
813
+ # * stream.memory.4xlarge
814
+ #
815
+ # * stream.memory.8xlarge
816
+ #
817
+ # * stream.graphics-design.large
818
+ #
819
+ # * stream.graphics-design.xlarge
820
+ #
821
+ # * stream.graphics-design.2xlarge
822
+ #
823
+ # * stream.graphics-design.4xlarge
824
+ #
825
+ # * stream.graphics-desktop.2xlarge
826
+ #
827
+ # * stream.graphics-pro.4xlarge
828
+ #
829
+ # * stream.graphics-pro.8xlarge
830
+ #
831
+ # * stream.graphics-pro.16xlarge
727
832
  #
728
833
  # @option params [String] :description
729
834
  # The description to display.
@@ -740,7 +845,17 @@ module Aws::AppStream
740
845
  # builder. To assume a role, the image builder calls the AWS Security
741
846
  # Token Service (STS) `AssumeRole` API operation and passes the ARN of
742
847
  # the role to use. The operation creates a new session with temporary
743
- # credentials.
848
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
849
+ # creates the **AppStream\_Machine\_Role** credential profile on the
850
+ # instance.
851
+ #
852
+ # For more information, see [Using an IAM Role to Grant Permissions to
853
+ # Applications and Scripts Running on AppStream 2.0 Streaming
854
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
855
+ #
856
+ #
857
+ #
858
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
744
859
  #
745
860
  # @option params [Boolean] :enable_default_internet_access
746
861
  # Enables or disables default internet access for the image builder.
@@ -948,6 +1063,11 @@ module Aws::AppStream
948
1063
  # of the stack can connect to AppStream 2.0 only through the specified
949
1064
  # endpoints.
950
1065
  #
1066
+ # @option params [Array<String>] :embed_host_domains
1067
+ # The domains where AppStream 2.0 streaming sessions can be embedded in
1068
+ # an iframe. You must approve the domains that you want to host embedded
1069
+ # AppStream 2.0 streaming sessions.
1070
+ #
951
1071
  # @return [Types::CreateStackResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
952
1072
  #
953
1073
  # * {Types::CreateStackResult#stack #stack} => Types::Stack
@@ -986,6 +1106,7 @@ module Aws::AppStream
986
1106
  # vpce_id: "String",
987
1107
  # },
988
1108
  # ],
1109
+ # embed_host_domains: ["EmbedHostDomain"],
989
1110
  # })
990
1111
  #
991
1112
  # @example Response structure
@@ -1014,6 +1135,8 @@ module Aws::AppStream
1014
1135
  # resp.stack.access_endpoints #=> Array
1015
1136
  # resp.stack.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
1016
1137
  # resp.stack.access_endpoints[0].vpce_id #=> String
1138
+ # resp.stack.embed_host_domains #=> Array
1139
+ # resp.stack.embed_host_domains[0] #=> String
1017
1140
  #
1018
1141
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStack AWS API Documentation
1019
1142
  #
@@ -1522,6 +1645,12 @@ module Aws::AppStream
1522
1645
  # resp.fleets[0].iam_role_arn #=> String
1523
1646
  # resp.next_token #=> String
1524
1647
  #
1648
+ #
1649
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1650
+ #
1651
+ # * fleet_started
1652
+ # * fleet_stopped
1653
+ #
1525
1654
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleets AWS API Documentation
1526
1655
  #
1527
1656
  # @overload describe_fleets(params = {})
@@ -1625,6 +1754,8 @@ module Aws::AppStream
1625
1754
  # * {Types::DescribeImagePermissionsResult#shared_image_permissions_list #shared_image_permissions_list} => Array&lt;Types::SharedImagePermissions&gt;
1626
1755
  # * {Types::DescribeImagePermissionsResult#next_token #next_token} => String
1627
1756
  #
1757
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1758
+ #
1628
1759
  # @example Request syntax with placeholder values
1629
1760
  #
1630
1761
  # resp = client.describe_image_permissions({
@@ -1677,6 +1808,8 @@ module Aws::AppStream
1677
1808
  # * {Types::DescribeImagesResult#images #images} => Array&lt;Types::Image&gt;
1678
1809
  # * {Types::DescribeImagesResult#next_token #next_token} => String
1679
1810
  #
1811
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1812
+ #
1680
1813
  # @example Request syntax with placeholder values
1681
1814
  #
1682
1815
  # resp = client.describe_images({
@@ -1846,6 +1979,8 @@ module Aws::AppStream
1846
1979
  # resp.stacks[0].access_endpoints #=> Array
1847
1980
  # resp.stacks[0].access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
1848
1981
  # resp.stacks[0].access_endpoints[0].vpce_id #=> String
1982
+ # resp.stacks[0].embed_host_domains #=> Array
1983
+ # resp.stacks[0].embed_host_domains[0] #=> String
1849
1984
  # resp.next_token #=> String
1850
1985
  #
1851
1986
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacks AWS API Documentation
@@ -2672,7 +2807,17 @@ module Aws::AppStream
2672
2807
  # To assume a role, a fleet instance calls the AWS Security Token
2673
2808
  # Service (STS) `AssumeRole` API operation and passes the ARN of the
2674
2809
  # role to use. The operation creates a new session with temporary
2675
- # credentials.
2810
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
2811
+ # creates the **AppStream\_Machine\_Role** credential profile on the
2812
+ # instance.
2813
+ #
2814
+ # For more information, see [Using an IAM Role to Grant Permissions to
2815
+ # Applications and Scripts Running on AppStream 2.0 Streaming
2816
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
2817
+ #
2818
+ #
2819
+ #
2820
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
2676
2821
  #
2677
2822
  # @return [Types::UpdateFleetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2678
2823
  #
@@ -2825,6 +2970,11 @@ module Aws::AppStream
2825
2970
  # of the stack can connect to AppStream 2.0 only through the specified
2826
2971
  # endpoints.
2827
2972
  #
2973
+ # @option params [Array<String>] :embed_host_domains
2974
+ # The domains where AppStream 2.0 streaming sessions can be embedded in
2975
+ # an iframe. You must approve the domains that you want to host embedded
2976
+ # AppStream 2.0 streaming sessions.
2977
+ #
2828
2978
  # @return [Types::UpdateStackResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2829
2979
  #
2830
2980
  # * {Types::UpdateStackResult#stack #stack} => Types::Stack
@@ -2845,7 +2995,7 @@ module Aws::AppStream
2845
2995
  # delete_storage_connectors: false,
2846
2996
  # redirect_url: "RedirectURL",
2847
2997
  # feedback_url: "FeedbackURL",
2848
- # attributes_to_delete: ["STORAGE_CONNECTORS"], # accepts STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, IAM_ROLE_ARN, ACCESS_ENDPOINTS
2998
+ # attributes_to_delete: ["STORAGE_CONNECTORS"], # accepts STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, EMBED_HOST_DOMAINS, IAM_ROLE_ARN, ACCESS_ENDPOINTS
2849
2999
  # user_settings: [
2850
3000
  # {
2851
3001
  # action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", # required, accepts CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE
@@ -2862,6 +3012,7 @@ module Aws::AppStream
2862
3012
  # vpce_id: "String",
2863
3013
  # },
2864
3014
  # ],
3015
+ # embed_host_domains: ["EmbedHostDomain"],
2865
3016
  # })
2866
3017
  #
2867
3018
  # @example Response structure
@@ -2890,6 +3041,8 @@ module Aws::AppStream
2890
3041
  # resp.stack.access_endpoints #=> Array
2891
3042
  # resp.stack.access_endpoints[0].endpoint_type #=> String, one of "STREAMING"
2892
3043
  # resp.stack.access_endpoints[0].vpce_id #=> String
3044
+ # resp.stack.embed_host_domains #=> Array
3045
+ # resp.stack.embed_host_domains[0] #=> String
2893
3046
  #
2894
3047
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStack AWS API Documentation
2895
3048
  #
@@ -2913,7 +3066,7 @@ module Aws::AppStream
2913
3066
  params: params,
2914
3067
  config: config)
2915
3068
  context[:gem_name] = 'aws-sdk-appstream'
2916
- context[:gem_version] = '1.36.0'
3069
+ context[:gem_version] = '1.41.0'
2917
3070
  Seahorse::Client::Request.new(handlers, context)
2918
3071
  end
2919
3072
 
@@ -2979,10 +3132,10 @@ module Aws::AppStream
2979
3132
  # The following table lists the valid waiter names, the operations they call,
2980
3133
  # and the default `:delay` and `:max_attempts` values.
2981
3134
  #
2982
- # | waiter_name | params | :delay | :max_attempts |
2983
- # | ------------- | ------------------ | -------- | ------------- |
2984
- # | fleet_started | {#describe_fleets} | 30 | 40 |
2985
- # | fleet_stopped | {#describe_fleets} | 30 | 40 |
3135
+ # | waiter_name | params | :delay | :max_attempts |
3136
+ # | ------------- | ------------------------ | -------- | ------------- |
3137
+ # | fleet_started | {Client#describe_fleets} | 30 | 40 |
3138
+ # | fleet_stopped | {Client#describe_fleets} | 30 | 40 |
2986
3139
  #
2987
3140
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
2988
3141
  # because the waiter has entered a state that it will not transition
@@ -106,6 +106,8 @@ module Aws::AppStream
106
106
  Domain = Shapes::StringShape.new(name: 'Domain')
107
107
  DomainJoinInfo = Shapes::StructureShape.new(name: 'DomainJoinInfo')
108
108
  DomainList = Shapes::ListShape.new(name: 'DomainList')
109
+ EmbedHostDomain = Shapes::StringShape.new(name: 'EmbedHostDomain')
110
+ EmbedHostDomains = Shapes::ListShape.new(name: 'EmbedHostDomains')
109
111
  EnableUserRequest = Shapes::StructureShape.new(name: 'EnableUserRequest')
110
112
  EnableUserResult = Shapes::StructureShape.new(name: 'EnableUserResult')
111
113
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
@@ -367,6 +369,7 @@ module Aws::AppStream
367
369
  CreateStackRequest.add_member(:application_settings, Shapes::ShapeRef.new(shape: ApplicationSettings, location_name: "ApplicationSettings"))
368
370
  CreateStackRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
369
371
  CreateStackRequest.add_member(:access_endpoints, Shapes::ShapeRef.new(shape: AccessEndpointList, location_name: "AccessEndpoints"))
372
+ CreateStackRequest.add_member(:embed_host_domains, Shapes::ShapeRef.new(shape: EmbedHostDomains, location_name: "EmbedHostDomains"))
370
373
  CreateStackRequest.struct_class = Types::CreateStackRequest
371
374
 
372
375
  CreateStackResult.add_member(:stack, Shapes::ShapeRef.new(shape: Stack, location_name: "Stack"))
@@ -566,6 +569,8 @@ module Aws::AppStream
566
569
 
567
570
  DomainList.member = Shapes::ShapeRef.new(shape: Domain)
568
571
 
572
+ EmbedHostDomains.member = Shapes::ShapeRef.new(shape: EmbedHostDomain)
573
+
569
574
  EnableUserRequest.add_member(:user_name, Shapes::ShapeRef.new(shape: Username, required: true, location_name: "UserName"))
570
575
  EnableUserRequest.add_member(:authentication_type, Shapes::ShapeRef.new(shape: AuthenticationType, required: true, location_name: "AuthenticationType"))
571
576
  EnableUserRequest.struct_class = Types::EnableUserRequest
@@ -774,6 +779,7 @@ module Aws::AppStream
774
779
  Stack.add_member(:user_settings, Shapes::ShapeRef.new(shape: UserSettingList, location_name: "UserSettings"))
775
780
  Stack.add_member(:application_settings, Shapes::ShapeRef.new(shape: ApplicationSettingsResponse, location_name: "ApplicationSettings"))
776
781
  Stack.add_member(:access_endpoints, Shapes::ShapeRef.new(shape: AccessEndpointList, location_name: "AccessEndpoints"))
782
+ Stack.add_member(:embed_host_domains, Shapes::ShapeRef.new(shape: EmbedHostDomains, location_name: "EmbedHostDomains"))
777
783
  Stack.struct_class = Types::Stack
778
784
 
779
785
  StackAttributes.member = Shapes::ShapeRef.new(shape: StackAttribute)
@@ -884,6 +890,7 @@ module Aws::AppStream
884
890
  UpdateStackRequest.add_member(:user_settings, Shapes::ShapeRef.new(shape: UserSettingList, location_name: "UserSettings"))
885
891
  UpdateStackRequest.add_member(:application_settings, Shapes::ShapeRef.new(shape: ApplicationSettings, location_name: "ApplicationSettings"))
886
892
  UpdateStackRequest.add_member(:access_endpoints, Shapes::ShapeRef.new(shape: AccessEndpointList, location_name: "AccessEndpoints"))
893
+ UpdateStackRequest.add_member(:embed_host_domains, Shapes::ShapeRef.new(shape: EmbedHostDomains, location_name: "EmbedHostDomains"))
887
894
  UpdateStackRequest.struct_class = Types::UpdateStackRequest
888
895
 
889
896
  UpdateStackResult.add_member(:stack, Shapes::ShapeRef.new(shape: Stack, location_name: "Stack"))
@@ -6,6 +6,39 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AppStream
9
+
10
+ # When AppStream returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::AppStream::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all AppStream errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::AppStream::Errors::ServiceError
18
+ # # rescues all AppStream API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {ConcurrentModificationException}
29
+ # * {IncompatibleImageException}
30
+ # * {InvalidAccountStatusException}
31
+ # * {InvalidParameterCombinationException}
32
+ # * {InvalidRoleException}
33
+ # * {LimitExceededException}
34
+ # * {OperationNotPermittedException}
35
+ # * {ResourceAlreadyExistsException}
36
+ # * {ResourceInUseException}
37
+ # * {ResourceNotAvailableException}
38
+ # * {ResourceNotFoundException}
39
+ #
40
+ # Additionally, error classes are dynamically generated for service errors based on the error code
41
+ # if they are not defined above.
9
42
  module Errors
10
43
 
11
44
  extend Aws::Errors::DynamicErrors
@@ -23,7 +56,6 @@ module Aws::AppStream
23
56
  def message
24
57
  @message || @data[:message]
25
58
  end
26
-
27
59
  end
28
60
 
29
61
  class IncompatibleImageException < ServiceError
@@ -39,7 +71,6 @@ module Aws::AppStream
39
71
  def message
40
72
  @message || @data[:message]
41
73
  end
42
-
43
74
  end
44
75
 
45
76
  class InvalidAccountStatusException < ServiceError
@@ -55,7 +86,6 @@ module Aws::AppStream
55
86
  def message
56
87
  @message || @data[:message]
57
88
  end
58
-
59
89
  end
60
90
 
61
91
  class InvalidParameterCombinationException < ServiceError
@@ -71,7 +101,6 @@ module Aws::AppStream
71
101
  def message
72
102
  @message || @data[:message]
73
103
  end
74
-
75
104
  end
76
105
 
77
106
  class InvalidRoleException < ServiceError
@@ -87,7 +116,6 @@ module Aws::AppStream
87
116
  def message
88
117
  @message || @data[:message]
89
118
  end
90
-
91
119
  end
92
120
 
93
121
  class LimitExceededException < ServiceError
@@ -103,7 +131,6 @@ module Aws::AppStream
103
131
  def message
104
132
  @message || @data[:message]
105
133
  end
106
-
107
134
  end
108
135
 
109
136
  class OperationNotPermittedException < ServiceError
@@ -119,7 +146,6 @@ module Aws::AppStream
119
146
  def message
120
147
  @message || @data[:message]
121
148
  end
122
-
123
149
  end
124
150
 
125
151
  class ResourceAlreadyExistsException < ServiceError
@@ -135,7 +161,6 @@ module Aws::AppStream
135
161
  def message
136
162
  @message || @data[:message]
137
163
  end
138
-
139
164
  end
140
165
 
141
166
  class ResourceInUseException < ServiceError
@@ -151,7 +176,6 @@ module Aws::AppStream
151
176
  def message
152
177
  @message || @data[:message]
153
178
  end
154
-
155
179
  end
156
180
 
157
181
  class ResourceNotAvailableException < ServiceError
@@ -167,7 +191,6 @@ module Aws::AppStream
167
191
  def message
168
192
  @message || @data[:message]
169
193
  end
170
-
171
194
  end
172
195
 
173
196
  class ResourceNotFoundException < ServiceError
@@ -183,7 +206,6 @@ module Aws::AppStream
183
206
  def message
184
207
  @message || @data[:message]
185
208
  end
186
-
187
209
  end
188
210
 
189
211
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AppStream
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -611,7 +611,17 @@ module Aws::AppStream
611
611
  # fleet. To assume a role, a fleet instance calls the AWS Security
612
612
  # Token Service (STS) `AssumeRole` API operation and passes the ARN of
613
613
  # the role to use. The operation creates a new session with temporary
614
- # credentials.
614
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
615
+ # creates the **AppStream\_Machine\_Role** credential profile on the
616
+ # instance.
617
+ #
618
+ # For more information, see [Using an IAM Role to Grant Permissions to
619
+ # Applications and Scripts Running on AppStream 2.0 Streaming
620
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
621
+ #
622
+ #
623
+ #
624
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
615
625
  # @return [String]
616
626
  #
617
627
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleetRequest AWS API Documentation
@@ -692,7 +702,48 @@ module Aws::AppStream
692
702
  # @return [String]
693
703
  #
694
704
  # @!attribute [rw] instance_type
695
- # The instance type to use when launching the image builder.
705
+ # The instance type to use when launching the image builder. The
706
+ # following instance types are available:
707
+ #
708
+ # * stream.standard.medium
709
+ #
710
+ # * stream.standard.large
711
+ #
712
+ # * stream.compute.large
713
+ #
714
+ # * stream.compute.xlarge
715
+ #
716
+ # * stream.compute.2xlarge
717
+ #
718
+ # * stream.compute.4xlarge
719
+ #
720
+ # * stream.compute.8xlarge
721
+ #
722
+ # * stream.memory.large
723
+ #
724
+ # * stream.memory.xlarge
725
+ #
726
+ # * stream.memory.2xlarge
727
+ #
728
+ # * stream.memory.4xlarge
729
+ #
730
+ # * stream.memory.8xlarge
731
+ #
732
+ # * stream.graphics-design.large
733
+ #
734
+ # * stream.graphics-design.xlarge
735
+ #
736
+ # * stream.graphics-design.2xlarge
737
+ #
738
+ # * stream.graphics-design.4xlarge
739
+ #
740
+ # * stream.graphics-desktop.2xlarge
741
+ #
742
+ # * stream.graphics-pro.4xlarge
743
+ #
744
+ # * stream.graphics-pro.8xlarge
745
+ #
746
+ # * stream.graphics-pro.16xlarge
696
747
  # @return [String]
697
748
  #
698
749
  # @!attribute [rw] description
@@ -713,7 +764,17 @@ module Aws::AppStream
713
764
  # builder. To assume a role, the image builder calls the AWS Security
714
765
  # Token Service (STS) `AssumeRole` API operation and passes the ARN of
715
766
  # the role to use. The operation creates a new session with temporary
716
- # credentials.
767
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
768
+ # creates the **AppStream\_Machine\_Role** credential profile on the
769
+ # instance.
770
+ #
771
+ # For more information, see [Using an IAM Role to Grant Permissions to
772
+ # Applications and Scripts Running on AppStream 2.0 Streaming
773
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
774
+ #
775
+ #
776
+ #
777
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
717
778
  # @return [String]
718
779
  #
719
780
  # @!attribute [rw] enable_default_internet_access
@@ -864,6 +925,7 @@ module Aws::AppStream
864
925
  # vpce_id: "String",
865
926
  # },
866
927
  # ],
928
+ # embed_host_domains: ["EmbedHostDomain"],
867
929
  # }
868
930
  #
869
931
  # @!attribute [rw] name
@@ -931,6 +993,12 @@ module Aws::AppStream
931
993
  # specified endpoints.
932
994
  # @return [Array<Types::AccessEndpoint>]
933
995
  #
996
+ # @!attribute [rw] embed_host_domains
997
+ # The domains where AppStream 2.0 streaming sessions can be embedded
998
+ # in an iframe. You must approve the domains that you want to host
999
+ # embedded AppStream 2.0 streaming sessions.
1000
+ # @return [Array<String>]
1001
+ #
934
1002
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStackRequest AWS API Documentation
935
1003
  #
936
1004
  class CreateStackRequest < Struct.new(
@@ -943,7 +1011,8 @@ module Aws::AppStream
943
1011
  :user_settings,
944
1012
  :application_settings,
945
1013
  :tags,
946
- :access_endpoints)
1014
+ :access_endpoints,
1015
+ :embed_host_domains)
947
1016
  include Aws::Structure
948
1017
  end
949
1018
 
@@ -2051,7 +2120,48 @@ module Aws::AppStream
2051
2120
  # @return [String]
2052
2121
  #
2053
2122
  # @!attribute [rw] instance_type
2054
- # The instance type to use when launching fleet instances.
2123
+ # The instance type to use when launching fleet instances. The
2124
+ # following instance types are available:
2125
+ #
2126
+ # * stream.standard.medium
2127
+ #
2128
+ # * stream.standard.large
2129
+ #
2130
+ # * stream.compute.large
2131
+ #
2132
+ # * stream.compute.xlarge
2133
+ #
2134
+ # * stream.compute.2xlarge
2135
+ #
2136
+ # * stream.compute.4xlarge
2137
+ #
2138
+ # * stream.compute.8xlarge
2139
+ #
2140
+ # * stream.memory.large
2141
+ #
2142
+ # * stream.memory.xlarge
2143
+ #
2144
+ # * stream.memory.2xlarge
2145
+ #
2146
+ # * stream.memory.4xlarge
2147
+ #
2148
+ # * stream.memory.8xlarge
2149
+ #
2150
+ # * stream.graphics-design.large
2151
+ #
2152
+ # * stream.graphics-design.xlarge
2153
+ #
2154
+ # * stream.graphics-design.2xlarge
2155
+ #
2156
+ # * stream.graphics-design.4xlarge
2157
+ #
2158
+ # * stream.graphics-desktop.2xlarge
2159
+ #
2160
+ # * stream.graphics-pro.4xlarge
2161
+ #
2162
+ # * stream.graphics-pro.8xlarge
2163
+ #
2164
+ # * stream.graphics-pro.16xlarge
2055
2165
  # @return [String]
2056
2166
  #
2057
2167
  # @!attribute [rw] fleet_type
@@ -2156,6 +2266,16 @@ module Aws::AppStream
2156
2266
  # role, the fleet instance calls the AWS Security Token Service (STS)
2157
2267
  # `AssumeRole` API operation and passes the ARN of the role to use.
2158
2268
  # The operation creates a new session with temporary credentials.
2269
+ # AppStream 2.0 retrieves the temporary credentials and creates the
2270
+ # **AppStream\_Machine\_Role** credential profile on the instance.
2271
+ #
2272
+ # For more information, see [Using an IAM Role to Grant Permissions to
2273
+ # Applications and Scripts Running on AppStream 2.0 Streaming
2274
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
2275
+ #
2276
+ #
2277
+ #
2278
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
2159
2279
  # @return [String]
2160
2280
  #
2161
2281
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Fleet AWS API Documentation
@@ -2323,7 +2443,48 @@ module Aws::AppStream
2323
2443
  # @return [Types::VpcConfig]
2324
2444
  #
2325
2445
  # @!attribute [rw] instance_type
2326
- # The instance type for the image builder.
2446
+ # The instance type for the image builder. The following instance
2447
+ # types are available:
2448
+ #
2449
+ # * stream.standard.medium
2450
+ #
2451
+ # * stream.standard.large
2452
+ #
2453
+ # * stream.compute.large
2454
+ #
2455
+ # * stream.compute.xlarge
2456
+ #
2457
+ # * stream.compute.2xlarge
2458
+ #
2459
+ # * stream.compute.4xlarge
2460
+ #
2461
+ # * stream.compute.8xlarge
2462
+ #
2463
+ # * stream.memory.large
2464
+ #
2465
+ # * stream.memory.xlarge
2466
+ #
2467
+ # * stream.memory.2xlarge
2468
+ #
2469
+ # * stream.memory.4xlarge
2470
+ #
2471
+ # * stream.memory.8xlarge
2472
+ #
2473
+ # * stream.graphics-design.large
2474
+ #
2475
+ # * stream.graphics-design.xlarge
2476
+ #
2477
+ # * stream.graphics-design.2xlarge
2478
+ #
2479
+ # * stream.graphics-design.4xlarge
2480
+ #
2481
+ # * stream.graphics-desktop.2xlarge
2482
+ #
2483
+ # * stream.graphics-pro.4xlarge
2484
+ #
2485
+ # * stream.graphics-pro.8xlarge
2486
+ #
2487
+ # * stream.graphics-pro.16xlarge
2327
2488
  # @return [String]
2328
2489
  #
2329
2490
  # @!attribute [rw] platform
@@ -2335,7 +2496,17 @@ module Aws::AppStream
2335
2496
  # assume a role, the image builder calls the AWS Security Token
2336
2497
  # Service (STS) `AssumeRole` API operation and passes the ARN of the
2337
2498
  # role to use. The operation creates a new session with temporary
2338
- # credentials.
2499
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
2500
+ # creates the **AppStream\_Machine\_Role** credential profile on the
2501
+ # instance.
2502
+ #
2503
+ # For more information, see [Using an IAM Role to Grant Permissions to
2504
+ # Applications and Scripts Running on AppStream 2.0 Streaming
2505
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
2506
+ #
2507
+ #
2508
+ #
2509
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
2339
2510
  # @return [String]
2340
2511
  #
2341
2512
  # @!attribute [rw] state
@@ -2948,6 +3119,12 @@ module Aws::AppStream
2948
3119
  # specified endpoints.
2949
3120
  # @return [Array<Types::AccessEndpoint>]
2950
3121
  #
3122
+ # @!attribute [rw] embed_host_domains
3123
+ # The domains where AppStream 2.0 streaming sessions can be embedded
3124
+ # in an iframe. You must approve the domains that you want to host
3125
+ # embedded AppStream 2.0 streaming sessions.
3126
+ # @return [Array<String>]
3127
+ #
2951
3128
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Stack AWS API Documentation
2952
3129
  #
2953
3130
  class Stack < Struct.new(
@@ -2962,7 +3139,8 @@ module Aws::AppStream
2962
3139
  :stack_errors,
2963
3140
  :user_settings,
2964
3141
  :application_settings,
2965
- :access_endpoints)
3142
+ :access_endpoints,
3143
+ :embed_host_domains)
2966
3144
  include Aws::Structure
2967
3145
  end
2968
3146
 
@@ -3415,7 +3593,17 @@ module Aws::AppStream
3415
3593
  # fleet. To assume a role, a fleet instance calls the AWS Security
3416
3594
  # Token Service (STS) `AssumeRole` API operation and passes the ARN of
3417
3595
  # the role to use. The operation creates a new session with temporary
3418
- # credentials.
3596
+ # credentials. AppStream 2.0 retrieves the temporary credentials and
3597
+ # creates the **AppStream\_Machine\_Role** credential profile on the
3598
+ # instance.
3599
+ #
3600
+ # For more information, see [Using an IAM Role to Grant Permissions to
3601
+ # Applications and Scripts Running on AppStream 2.0 Streaming
3602
+ # Instances][1] in the *Amazon AppStream 2.0 Administration Guide*.
3603
+ #
3604
+ #
3605
+ #
3606
+ # [1]: https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html
3419
3607
  # @return [String]
3420
3608
  #
3421
3609
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleetRequest AWS API Documentation
@@ -3506,7 +3694,7 @@ module Aws::AppStream
3506
3694
  # delete_storage_connectors: false,
3507
3695
  # redirect_url: "RedirectURL",
3508
3696
  # feedback_url: "FeedbackURL",
3509
- # attributes_to_delete: ["STORAGE_CONNECTORS"], # accepts STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, IAM_ROLE_ARN, ACCESS_ENDPOINTS
3697
+ # attributes_to_delete: ["STORAGE_CONNECTORS"], # accepts STORAGE_CONNECTORS, STORAGE_CONNECTOR_HOMEFOLDERS, STORAGE_CONNECTOR_GOOGLE_DRIVE, STORAGE_CONNECTOR_ONE_DRIVE, REDIRECT_URL, FEEDBACK_URL, THEME_NAME, USER_SETTINGS, EMBED_HOST_DOMAINS, IAM_ROLE_ARN, ACCESS_ENDPOINTS
3510
3698
  # user_settings: [
3511
3699
  # {
3512
3700
  # action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", # required, accepts CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, FILE_UPLOAD, FILE_DOWNLOAD, PRINTING_TO_LOCAL_DEVICE
@@ -3523,6 +3711,7 @@ module Aws::AppStream
3523
3711
  # vpce_id: "String",
3524
3712
  # },
3525
3713
  # ],
3714
+ # embed_host_domains: ["EmbedHostDomain"],
3526
3715
  # }
3527
3716
  #
3528
3717
  # @!attribute [rw] display_name
@@ -3578,6 +3767,12 @@ module Aws::AppStream
3578
3767
  # specified endpoints.
3579
3768
  # @return [Array<Types::AccessEndpoint>]
3580
3769
  #
3770
+ # @!attribute [rw] embed_host_domains
3771
+ # The domains where AppStream 2.0 streaming sessions can be embedded
3772
+ # in an iframe. You must approve the domains that you want to host
3773
+ # embedded AppStream 2.0 streaming sessions.
3774
+ # @return [Array<String>]
3775
+ #
3581
3776
  # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStackRequest AWS API Documentation
3582
3777
  #
3583
3778
  class UpdateStackRequest < Struct.new(
@@ -3591,7 +3786,8 @@ module Aws::AppStream
3591
3786
  :attributes_to_delete,
3592
3787
  :user_settings,
3593
3788
  :application_settings,
3594
- :access_endpoints)
3789
+ :access_endpoints,
3790
+ :embed_host_domains)
3595
3791
  include Aws::Structure
3596
3792
  end
3597
3793
 
@@ -8,6 +8,68 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::AppStream
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | ------------- | ------------------------ | -------- | ------------- |
70
+ # | fleet_started | {Client#describe_fleets} | 30 | 40 |
71
+ # | fleet_stopped | {Client#describe_fleets} | 30 | 40 |
72
+ #
11
73
  module Waiters
12
74
 
13
75
  class FleetStarted
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-appstream
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.36.0
4
+ version: 1.41.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-09-09 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.61.1
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.61.1
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
82
  version: '0'
83
83
  requirements: []
84
84
  rubyforge_project:
85
- rubygems_version: 2.5.2.3
85
+ rubygems_version: 2.7.6.2
86
86
  signing_key:
87
87
  specification_version: 4
88
88
  summary: AWS SDK for Ruby - Amazon AppStream