aws-sdk-appstream 1.61.0 → 1.64.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.
@@ -300,6 +300,41 @@ module Aws::AppStream
300
300
  include Aws::Structure
301
301
  end
302
302
 
303
+ # @note When making an API call, you may pass AssociateApplicationToEntitlementRequest
304
+ # data as a hash:
305
+ #
306
+ # {
307
+ # stack_name: "Name", # required
308
+ # entitlement_name: "Name", # required
309
+ # application_identifier: "String", # required
310
+ # }
311
+ #
312
+ # @!attribute [rw] stack_name
313
+ # The name of the stack.
314
+ # @return [String]
315
+ #
316
+ # @!attribute [rw] entitlement_name
317
+ # The name of the entitlement.
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] application_identifier
321
+ # The identifier of the application.
322
+ # @return [String]
323
+ #
324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateApplicationToEntitlementRequest AWS API Documentation
325
+ #
326
+ class AssociateApplicationToEntitlementRequest < Struct.new(
327
+ :stack_name,
328
+ :entitlement_name,
329
+ :application_identifier)
330
+ SENSITIVE = []
331
+ include Aws::Structure
332
+ end
333
+
334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateApplicationToEntitlementResult AWS API Documentation
335
+ #
336
+ class AssociateApplicationToEntitlementResult < Aws::EmptyStructure; end
337
+
303
338
  # @note When making an API call, you may pass AssociateFleetRequest
304
339
  # data as a hash:
305
340
  #
@@ -748,6 +783,66 @@ module Aws::AppStream
748
783
  include Aws::Structure
749
784
  end
750
785
 
786
+ # @note When making an API call, you may pass CreateEntitlementRequest
787
+ # data as a hash:
788
+ #
789
+ # {
790
+ # name: "Name", # required
791
+ # stack_name: "Name", # required
792
+ # description: "Description",
793
+ # app_visibility: "ALL", # required, accepts ALL, ASSOCIATED
794
+ # attributes: [ # required
795
+ # {
796
+ # name: "String", # required
797
+ # value: "String", # required
798
+ # },
799
+ # ],
800
+ # }
801
+ #
802
+ # @!attribute [rw] name
803
+ # The name of the entitlement.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] stack_name
807
+ # The name of the stack with which the entitlement is associated.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] description
811
+ # The description of the entitlement.
812
+ # @return [String]
813
+ #
814
+ # @!attribute [rw] app_visibility
815
+ # Specifies whether all or selected apps are entitled.
816
+ # @return [String]
817
+ #
818
+ # @!attribute [rw] attributes
819
+ # The attributes of the entitlement.
820
+ # @return [Array<Types::EntitlementAttribute>]
821
+ #
822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateEntitlementRequest AWS API Documentation
823
+ #
824
+ class CreateEntitlementRequest < Struct.new(
825
+ :name,
826
+ :stack_name,
827
+ :description,
828
+ :app_visibility,
829
+ :attributes)
830
+ SENSITIVE = []
831
+ include Aws::Structure
832
+ end
833
+
834
+ # @!attribute [rw] entitlement
835
+ # The entitlement.
836
+ # @return [Types::Entitlement]
837
+ #
838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateEntitlementResult AWS API Documentation
839
+ #
840
+ class CreateEntitlementResult < Struct.new(
841
+ :entitlement)
842
+ SENSITIVE = []
843
+ include Aws::Structure
844
+ end
845
+
751
846
  # @note When making an API call, you may pass CreateFleetRequest
752
847
  # data as a hash:
753
848
  #
@@ -1808,6 +1903,35 @@ module Aws::AppStream
1808
1903
  #
1809
1904
  class DeleteDirectoryConfigResult < Aws::EmptyStructure; end
1810
1905
 
1906
+ # @note When making an API call, you may pass DeleteEntitlementRequest
1907
+ # data as a hash:
1908
+ #
1909
+ # {
1910
+ # name: "Name", # required
1911
+ # stack_name: "Name", # required
1912
+ # }
1913
+ #
1914
+ # @!attribute [rw] name
1915
+ # The name of the entitlement.
1916
+ # @return [String]
1917
+ #
1918
+ # @!attribute [rw] stack_name
1919
+ # The name of the stack with which the entitlement is associated.
1920
+ # @return [String]
1921
+ #
1922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteEntitlementRequest AWS API Documentation
1923
+ #
1924
+ class DeleteEntitlementRequest < Struct.new(
1925
+ :name,
1926
+ :stack_name)
1927
+ SENSITIVE = []
1928
+ include Aws::Structure
1929
+ end
1930
+
1931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteEntitlementResult AWS API Documentation
1932
+ #
1933
+ class DeleteEntitlementResult < Aws::EmptyStructure; end
1934
+
1811
1935
  # @note When making an API call, you may pass DeleteFleetRequest
1812
1936
  # data as a hash:
1813
1937
  #
@@ -2197,6 +2321,62 @@ module Aws::AppStream
2197
2321
  include Aws::Structure
2198
2322
  end
2199
2323
 
2324
+ # @note When making an API call, you may pass DescribeEntitlementsRequest
2325
+ # data as a hash:
2326
+ #
2327
+ # {
2328
+ # name: "Name",
2329
+ # stack_name: "Name", # required
2330
+ # next_token: "String",
2331
+ # max_results: 1,
2332
+ # }
2333
+ #
2334
+ # @!attribute [rw] name
2335
+ # The name of the entitlement.
2336
+ # @return [String]
2337
+ #
2338
+ # @!attribute [rw] stack_name
2339
+ # The name of the stack with which the entitlement is associated.
2340
+ # @return [String]
2341
+ #
2342
+ # @!attribute [rw] next_token
2343
+ # The pagination token used to retrieve the next page of results for
2344
+ # this operation.
2345
+ # @return [String]
2346
+ #
2347
+ # @!attribute [rw] max_results
2348
+ # The maximum size of each page of results.
2349
+ # @return [Integer]
2350
+ #
2351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeEntitlementsRequest AWS API Documentation
2352
+ #
2353
+ class DescribeEntitlementsRequest < Struct.new(
2354
+ :name,
2355
+ :stack_name,
2356
+ :next_token,
2357
+ :max_results)
2358
+ SENSITIVE = []
2359
+ include Aws::Structure
2360
+ end
2361
+
2362
+ # @!attribute [rw] entitlements
2363
+ # The entitlements.
2364
+ # @return [Array<Types::Entitlement>]
2365
+ #
2366
+ # @!attribute [rw] next_token
2367
+ # The pagination token used to retrieve the next page of results for
2368
+ # this operation.
2369
+ # @return [String]
2370
+ #
2371
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeEntitlementsResult AWS API Documentation
2372
+ #
2373
+ class DescribeEntitlementsResult < Struct.new(
2374
+ :entitlements,
2375
+ :next_token)
2376
+ SENSITIVE = []
2377
+ include Aws::Structure
2378
+ end
2379
+
2200
2380
  # @note When making an API call, you may pass DescribeFleetsRequest
2201
2381
  # data as a hash:
2202
2382
  #
@@ -2789,6 +2969,41 @@ module Aws::AppStream
2789
2969
  #
2790
2970
  class DisassociateApplicationFleetResult < Aws::EmptyStructure; end
2791
2971
 
2972
+ # @note When making an API call, you may pass DisassociateApplicationFromEntitlementRequest
2973
+ # data as a hash:
2974
+ #
2975
+ # {
2976
+ # stack_name: "Name", # required
2977
+ # entitlement_name: "Name", # required
2978
+ # application_identifier: "String", # required
2979
+ # }
2980
+ #
2981
+ # @!attribute [rw] stack_name
2982
+ # The name of the stack with which the entitlement is associated.
2983
+ # @return [String]
2984
+ #
2985
+ # @!attribute [rw] entitlement_name
2986
+ # The name of the entitlement.
2987
+ # @return [String]
2988
+ #
2989
+ # @!attribute [rw] application_identifier
2990
+ # The identifier of the application to remove from the entitlement.
2991
+ # @return [String]
2992
+ #
2993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateApplicationFromEntitlementRequest AWS API Documentation
2994
+ #
2995
+ class DisassociateApplicationFromEntitlementRequest < Struct.new(
2996
+ :stack_name,
2997
+ :entitlement_name,
2998
+ :application_identifier)
2999
+ SENSITIVE = []
3000
+ include Aws::Structure
3001
+ end
3002
+
3003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateApplicationFromEntitlementResult AWS API Documentation
3004
+ #
3005
+ class DisassociateApplicationFromEntitlementResult < Aws::EmptyStructure; end
3006
+
2792
3007
  # @note When making an API call, you may pass DisassociateFleetRequest
2793
3008
  # data as a hash:
2794
3009
  #
@@ -2884,6 +3099,148 @@ module Aws::AppStream
2884
3099
  #
2885
3100
  class EnableUserResult < Aws::EmptyStructure; end
2886
3101
 
3102
+ # The application associated to an entitlement. Access is controlled
3103
+ # based on user attributes.
3104
+ #
3105
+ # @!attribute [rw] application_identifier
3106
+ # The identifier of the application.
3107
+ # @return [String]
3108
+ #
3109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/EntitledApplication AWS API Documentation
3110
+ #
3111
+ class EntitledApplication < Struct.new(
3112
+ :application_identifier)
3113
+ SENSITIVE = []
3114
+ include Aws::Structure
3115
+ end
3116
+
3117
+ # Specifies an entitlement. Entitlements control access to specific
3118
+ # applications within a stack, based on user attributes. Entitlements
3119
+ # apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user
3120
+ # pool and streaming URL users are entitled to all applications in a
3121
+ # stack. Entitlements don't apply to the desktop stream view
3122
+ # application, or to applications managed by a dynamic app provider
3123
+ # using the Dynamic Application Framework.
3124
+ #
3125
+ # @!attribute [rw] name
3126
+ # The name of the entitlement.
3127
+ # @return [String]
3128
+ #
3129
+ # @!attribute [rw] stack_name
3130
+ # The name of the stack with which the entitlement is associated.
3131
+ # @return [String]
3132
+ #
3133
+ # @!attribute [rw] description
3134
+ # The description of the entitlement.
3135
+ # @return [String]
3136
+ #
3137
+ # @!attribute [rw] app_visibility
3138
+ # Specifies whether all or selected apps are entitled.
3139
+ # @return [String]
3140
+ #
3141
+ # @!attribute [rw] attributes
3142
+ # The attributes of the entitlement.
3143
+ # @return [Array<Types::EntitlementAttribute>]
3144
+ #
3145
+ # @!attribute [rw] created_time
3146
+ # The time when the entitlement was created.
3147
+ # @return [Time]
3148
+ #
3149
+ # @!attribute [rw] last_modified_time
3150
+ # The time when the entitlement was last modified.
3151
+ # @return [Time]
3152
+ #
3153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Entitlement AWS API Documentation
3154
+ #
3155
+ class Entitlement < Struct.new(
3156
+ :name,
3157
+ :stack_name,
3158
+ :description,
3159
+ :app_visibility,
3160
+ :attributes,
3161
+ :created_time,
3162
+ :last_modified_time)
3163
+ SENSITIVE = []
3164
+ include Aws::Structure
3165
+ end
3166
+
3167
+ # The entitlement already exists.
3168
+ #
3169
+ # @!attribute [rw] message
3170
+ # The error message in the exception.
3171
+ # @return [String]
3172
+ #
3173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/EntitlementAlreadyExistsException AWS API Documentation
3174
+ #
3175
+ class EntitlementAlreadyExistsException < Struct.new(
3176
+ :message)
3177
+ SENSITIVE = []
3178
+ include Aws::Structure
3179
+ end
3180
+
3181
+ # An attribute associated with an entitlement. Application entitlements
3182
+ # work by matching a supported SAML 2.0 attribute name to a value when a
3183
+ # user identity federates to an Amazon AppStream 2.0 SAML application.
3184
+ #
3185
+ # @note When making an API call, you may pass EntitlementAttribute
3186
+ # data as a hash:
3187
+ #
3188
+ # {
3189
+ # name: "String", # required
3190
+ # value: "String", # required
3191
+ # }
3192
+ #
3193
+ # @!attribute [rw] name
3194
+ # A supported AWS IAM SAML `PrincipalTag` attribute that is matched to
3195
+ # the associated value when a user identity federates into an Amazon
3196
+ # AppStream 2.0 SAML application.
3197
+ #
3198
+ # The following are valid values:
3199
+ #
3200
+ # * roles
3201
+ #
3202
+ # * department
3203
+ #
3204
+ # * organization
3205
+ #
3206
+ # * groups
3207
+ #
3208
+ # * title
3209
+ #
3210
+ # * costCenter
3211
+ #
3212
+ # * userType
3213
+ # @return [String]
3214
+ #
3215
+ # @!attribute [rw] value
3216
+ # A value that is matched to a supported SAML attribute name when a
3217
+ # user identity federates into an Amazon AppStream 2.0 SAML
3218
+ # application.
3219
+ # @return [String]
3220
+ #
3221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/EntitlementAttribute AWS API Documentation
3222
+ #
3223
+ class EntitlementAttribute < Struct.new(
3224
+ :name,
3225
+ :value)
3226
+ SENSITIVE = []
3227
+ include Aws::Structure
3228
+ end
3229
+
3230
+ # The entitlement can't be found.
3231
+ #
3232
+ # @!attribute [rw] message
3233
+ # The error message in the exception.
3234
+ # @return [String]
3235
+ #
3236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/EntitlementNotFoundException AWS API Documentation
3237
+ #
3238
+ class EntitlementNotFoundException < Struct.new(
3239
+ :message)
3240
+ SENSITIVE = []
3241
+ include Aws::Structure
3242
+ end
3243
+
2887
3244
  # @note When making an API call, you may pass ExpireSessionRequest
2888
3245
  # data as a hash:
2889
3246
  #
@@ -3723,6 +4080,62 @@ module Aws::AppStream
3723
4080
  include Aws::Structure
3724
4081
  end
3725
4082
 
4083
+ # @note When making an API call, you may pass ListEntitledApplicationsRequest
4084
+ # data as a hash:
4085
+ #
4086
+ # {
4087
+ # stack_name: "Name", # required
4088
+ # entitlement_name: "Name", # required
4089
+ # next_token: "String",
4090
+ # max_results: 1,
4091
+ # }
4092
+ #
4093
+ # @!attribute [rw] stack_name
4094
+ # The name of the stack with which the entitlement is associated.
4095
+ # @return [String]
4096
+ #
4097
+ # @!attribute [rw] entitlement_name
4098
+ # The name of the entitlement.
4099
+ # @return [String]
4100
+ #
4101
+ # @!attribute [rw] next_token
4102
+ # The pagination token used to retrieve the next page of results for
4103
+ # this operation.
4104
+ # @return [String]
4105
+ #
4106
+ # @!attribute [rw] max_results
4107
+ # The maximum size of each page of results.
4108
+ # @return [Integer]
4109
+ #
4110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListEntitledApplicationsRequest AWS API Documentation
4111
+ #
4112
+ class ListEntitledApplicationsRequest < Struct.new(
4113
+ :stack_name,
4114
+ :entitlement_name,
4115
+ :next_token,
4116
+ :max_results)
4117
+ SENSITIVE = []
4118
+ include Aws::Structure
4119
+ end
4120
+
4121
+ # @!attribute [rw] entitled_applications
4122
+ # The entitled applications.
4123
+ # @return [Array<Types::EntitledApplication>]
4124
+ #
4125
+ # @!attribute [rw] next_token
4126
+ # The pagination token used to retrieve the next page of results for
4127
+ # this operation.
4128
+ # @return [String]
4129
+ #
4130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListEntitledApplicationsResult AWS API Documentation
4131
+ #
4132
+ class ListEntitledApplicationsResult < Struct.new(
4133
+ :entitled_applications,
4134
+ :next_token)
4135
+ SENSITIVE = []
4136
+ include Aws::Structure
4137
+ end
4138
+
3726
4139
  # @note When making an API call, you may pass ListTagsForResourceRequest
3727
4140
  # data as a hash:
3728
4141
  #
@@ -4526,6 +4939,66 @@ module Aws::AppStream
4526
4939
  include Aws::Structure
4527
4940
  end
4528
4941
 
4942
+ # @note When making an API call, you may pass UpdateEntitlementRequest
4943
+ # data as a hash:
4944
+ #
4945
+ # {
4946
+ # name: "Name", # required
4947
+ # stack_name: "Name", # required
4948
+ # description: "Description",
4949
+ # app_visibility: "ALL", # accepts ALL, ASSOCIATED
4950
+ # attributes: [
4951
+ # {
4952
+ # name: "String", # required
4953
+ # value: "String", # required
4954
+ # },
4955
+ # ],
4956
+ # }
4957
+ #
4958
+ # @!attribute [rw] name
4959
+ # The name of the entitlement.
4960
+ # @return [String]
4961
+ #
4962
+ # @!attribute [rw] stack_name
4963
+ # The name of the stack with which the entitlement is associated.
4964
+ # @return [String]
4965
+ #
4966
+ # @!attribute [rw] description
4967
+ # The description of the entitlement.
4968
+ # @return [String]
4969
+ #
4970
+ # @!attribute [rw] app_visibility
4971
+ # Specifies whether all or only selected apps are entitled.
4972
+ # @return [String]
4973
+ #
4974
+ # @!attribute [rw] attributes
4975
+ # The attributes of the entitlement.
4976
+ # @return [Array<Types::EntitlementAttribute>]
4977
+ #
4978
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateEntitlementRequest AWS API Documentation
4979
+ #
4980
+ class UpdateEntitlementRequest < Struct.new(
4981
+ :name,
4982
+ :stack_name,
4983
+ :description,
4984
+ :app_visibility,
4985
+ :attributes)
4986
+ SENSITIVE = []
4987
+ include Aws::Structure
4988
+ end
4989
+
4990
+ # @!attribute [rw] entitlement
4991
+ # The entitlement.
4992
+ # @return [Types::Entitlement]
4993
+ #
4994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateEntitlementResult AWS API Documentation
4995
+ #
4996
+ class UpdateEntitlementResult < Struct.new(
4997
+ :entitlement)
4998
+ SENSITIVE = []
4999
+ include Aws::Structure
5000
+ end
5001
+
4529
5002
  # @note When making an API call, you may pass UpdateFleetRequest
4530
5003
  # data as a hash:
4531
5004
  #
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-appstream/customizations'
49
49
  # @!group service
50
50
  module Aws::AppStream
51
51
 
52
- GEM_VERSION = '1.61.0'
52
+ GEM_VERSION = '1.64.0'
53
53
 
54
54
  end
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.61.0
4
+ version: 1.64.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: 2021-12-21 00:00:00.000000000 Z
11
+ date: 2022-02-24 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.125.0
22
+ version: 3.127.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.125.0
32
+ version: 3.127.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement