aws-sdk-cognitoidentityprovider 1.11.0 → 1.12.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
2
  SHA1:
3
- metadata.gz: 64de73e536c01c464bd5f7d5c7e556975346d5d3
4
- data.tar.gz: 6128d9424928d99d422b244e81d9b31867fda48d
3
+ metadata.gz: ed661ce07cf7b44b0979a419205b17e1b0591040
4
+ data.tar.gz: 031b8d9f68d28909900ee1fe7a9731c5e735fdff
5
5
  SHA512:
6
- metadata.gz: ffc7a907429bfe35ee0c15fda8584440052be76af11ac6900f6eee50c4fdb10063c936706d8b995e65edd25f8475acd4fb1a17a29d21c8a0f6c1b326e2f25bf0
7
- data.tar.gz: 879f50e6498c9fd3f47ffcb2501ab120df679ffabb2e85386c7e9b5f1f249e78ada05af99df657cc5e1e653e128f8df5e47785fd07b8189dca0633f23bf9ab57
6
+ metadata.gz: 3732d8485b7845a54a5c9d846ab6be5d11a6184acd09f17200ddef2d45b07c12e6a4beb65a7808581373b03bb1ba8dad70a6fcad0cd732bf4c3ae672e0b58e02
7
+ data.tar.gz: 5904f0cb5456980d7bb97e6de54a1db076e4d66372fc6cca236374c7ba7a2631cf4140bab99b74922219b7807eba97bd2df4269894f6f457cb515f8d69cb8b2a
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-cognitoidentityprovider/customizations'
42
42
  # @service
43
43
  module Aws::CognitoIdentityProvider
44
44
 
45
- GEM_VERSION = '1.11.0'
45
+ GEM_VERSION = '1.12.0'
46
46
 
47
47
  end
@@ -2361,7 +2361,20 @@ module Aws::CognitoIdentityProvider
2361
2361
  # The read attributes.
2362
2362
  #
2363
2363
  # @option params [Array<String>] :write_attributes
2364
- # The write attributes.
2364
+ # The user pool attributes that the app client can write to.
2365
+ #
2366
+ # If your app client allows users to sign in through an identity
2367
+ # provider, this array must include all attributes that are mapped to
2368
+ # identity provider attributes. Amazon Cognito updates mapped attributes
2369
+ # when users sign in to your application through an identity provider.
2370
+ # If your app client lacks write access to a mapped attribute, Amazon
2371
+ # Cognito throws an error when it attempts to update the attribute. For
2372
+ # more information, see [Specifying Identity Provider Attribute Mappings
2373
+ # for Your User Pool][1].
2374
+ #
2375
+ #
2376
+ #
2377
+ # [1]: http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
2365
2378
  #
2366
2379
  # @option params [Array<String>] :explicit_auth_flows
2367
2380
  # The explicit authentication flows.
@@ -2519,7 +2532,7 @@ module Aws::CognitoIdentityProvider
2519
2532
  # The configuration for a custom domain that hosts the sign-up and
2520
2533
  # sign-in webpages for your application.
2521
2534
  #
2522
- # Provide this parameter only if you want to use own custom domain for
2535
+ # Provide this parameter only if you want to use a custom domain for
2523
2536
  # your user pool. Otherwise, you can exclude this parameter and use the
2524
2537
  # Amazon Cognito hosted domain instead.
2525
2538
  #
@@ -5428,6 +5441,85 @@ module Aws::CognitoIdentityProvider
5428
5441
  req.send_request(options)
5429
5442
  end
5430
5443
 
5444
+ # Updates the Secure Sockets Layer (SSL) certificate for the custom
5445
+ # domain for your user pool.
5446
+ #
5447
+ # You can use this operation to provide the Amazon Resource Name (ARN)
5448
+ # of a new certificate to Amazon Cognito. You cannot use it to change
5449
+ # the domain for a user pool.
5450
+ #
5451
+ # A custom domain is used to host the Amazon Cognito hosted UI, which
5452
+ # provides sign-up and sign-in pages for your application. When you set
5453
+ # up a custom domain, you provide a certificate that you manage with AWS
5454
+ # Certificate Manager (ACM). When necessary, you can use this operation
5455
+ # to change the certificate that you applied to your custom domain.
5456
+ #
5457
+ # Usually, this is unnecessary following routine certificate renewal
5458
+ # with ACM. When you renew your existing certificate in ACM, the ARN for
5459
+ # your certificate remains the same, and your custom domain uses the new
5460
+ # certificate automatically.
5461
+ #
5462
+ # However, if you replace your existing certificate with a new one, ACM
5463
+ # gives the new certificate a new ARN. To apply the new certificate to
5464
+ # your custom domain, you must provide this ARN to Amazon Cognito.
5465
+ #
5466
+ # When you add your new certificate in ACM, you must choose US East (N.
5467
+ # Virginia) as the AWS Region.
5468
+ #
5469
+ # After you submit your request, Amazon Cognito requires up to 1 hour to
5470
+ # distribute your new certificate to your custom domain.
5471
+ #
5472
+ # For more information about adding a custom domain to your user pool,
5473
+ # see [Using Your Own Domain for the Hosted UI][1].
5474
+ #
5475
+ #
5476
+ #
5477
+ # [1]: http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html
5478
+ #
5479
+ # @option params [required, String] :domain
5480
+ # The domain name for the custom domain that hosts the sign-up and
5481
+ # sign-in pages for your application. For example: `auth.example.com`.
5482
+ #
5483
+ # This string can include only lowercase letters, numbers, and hyphens.
5484
+ # Do not use a hyphen for the first or last character. Use periods to
5485
+ # separate subdomain names.
5486
+ #
5487
+ # @option params [required, String] :user_pool_id
5488
+ # The ID of the user pool that is associated with the custom domain that
5489
+ # you are updating the certificate for.
5490
+ #
5491
+ # @option params [required, Types::CustomDomainConfigType] :custom_domain_config
5492
+ # The configuration for a custom domain that hosts the sign-up and
5493
+ # sign-in pages for your application. Use this object to specify an SSL
5494
+ # certificate that is managed by ACM.
5495
+ #
5496
+ # @return [Types::UpdateUserPoolDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5497
+ #
5498
+ # * {Types::UpdateUserPoolDomainResponse#cloud_front_domain #cloud_front_domain} => String
5499
+ #
5500
+ # @example Request syntax with placeholder values
5501
+ #
5502
+ # resp = client.update_user_pool_domain({
5503
+ # domain: "DomainType", # required
5504
+ # user_pool_id: "UserPoolIdType", # required
5505
+ # custom_domain_config: { # required
5506
+ # certificate_arn: "ArnType", # required
5507
+ # },
5508
+ # })
5509
+ #
5510
+ # @example Response structure
5511
+ #
5512
+ # resp.cloud_front_domain #=> String
5513
+ #
5514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolDomain AWS API Documentation
5515
+ #
5516
+ # @overload update_user_pool_domain(params = {})
5517
+ # @param [Hash] params ({})
5518
+ def update_user_pool_domain(params = {}, options = {})
5519
+ req = build_request(:update_user_pool_domain, params)
5520
+ req.send_request(options)
5521
+ end
5522
+
5431
5523
  # Use this API to register a user's entered TOTP code and mark the
5432
5524
  # user's software token MFA status as "verified" if successful. The
5433
5525
  # request takes an access token or a session string, but not both.
@@ -5516,7 +5608,7 @@ module Aws::CognitoIdentityProvider
5516
5608
  params: params,
5517
5609
  config: config)
5518
5610
  context[:gem_name] = 'aws-sdk-cognitoidentityprovider'
5519
- context[:gem_version] = '1.11.0'
5611
+ context[:gem_version] = '1.12.0'
5520
5612
  Seahorse::Client::Request.new(handlers, context)
5521
5613
  end
5522
5614
 
@@ -391,6 +391,8 @@ module Aws::CognitoIdentityProvider
391
391
  UpdateUserAttributesResponse = Shapes::StructureShape.new(name: 'UpdateUserAttributesResponse')
392
392
  UpdateUserPoolClientRequest = Shapes::StructureShape.new(name: 'UpdateUserPoolClientRequest')
393
393
  UpdateUserPoolClientResponse = Shapes::StructureShape.new(name: 'UpdateUserPoolClientResponse')
394
+ UpdateUserPoolDomainRequest = Shapes::StructureShape.new(name: 'UpdateUserPoolDomainRequest')
395
+ UpdateUserPoolDomainResponse = Shapes::StructureShape.new(name: 'UpdateUserPoolDomainResponse')
394
396
  UpdateUserPoolRequest = Shapes::StructureShape.new(name: 'UpdateUserPoolRequest')
395
397
  UpdateUserPoolResponse = Shapes::StructureShape.new(name: 'UpdateUserPoolResponse')
396
398
  UserContextDataType = Shapes::StructureShape.new(name: 'UserContextDataType')
@@ -1553,6 +1555,14 @@ module Aws::CognitoIdentityProvider
1553
1555
  UpdateUserPoolClientResponse.add_member(:user_pool_client, Shapes::ShapeRef.new(shape: UserPoolClientType, location_name: "UserPoolClient"))
1554
1556
  UpdateUserPoolClientResponse.struct_class = Types::UpdateUserPoolClientResponse
1555
1557
 
1558
+ UpdateUserPoolDomainRequest.add_member(:domain, Shapes::ShapeRef.new(shape: DomainType, required: true, location_name: "Domain"))
1559
+ UpdateUserPoolDomainRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
1560
+ UpdateUserPoolDomainRequest.add_member(:custom_domain_config, Shapes::ShapeRef.new(shape: CustomDomainConfigType, required: true, location_name: "CustomDomainConfig"))
1561
+ UpdateUserPoolDomainRequest.struct_class = Types::UpdateUserPoolDomainRequest
1562
+
1563
+ UpdateUserPoolDomainResponse.add_member(:cloud_front_domain, Shapes::ShapeRef.new(shape: DomainType, location_name: "CloudFrontDomain"))
1564
+ UpdateUserPoolDomainResponse.struct_class = Types::UpdateUserPoolDomainResponse
1565
+
1556
1566
  UpdateUserPoolRequest.add_member(:user_pool_id, Shapes::ShapeRef.new(shape: UserPoolIdType, required: true, location_name: "UserPoolId"))
1557
1567
  UpdateUserPoolRequest.add_member(:policies, Shapes::ShapeRef.new(shape: UserPoolPolicyType, location_name: "Policies"))
1558
1568
  UpdateUserPoolRequest.add_member(:lambda_config, Shapes::ShapeRef.new(shape: LambdaConfigType, location_name: "LambdaConfig"))
@@ -3199,6 +3209,19 @@ module Aws::CognitoIdentityProvider
3199
3209
  o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
3200
3210
  end)
3201
3211
 
3212
+ api.add_operation(:update_user_pool_domain, Seahorse::Model::Operation.new.tap do |o|
3213
+ o.name = "UpdateUserPoolDomain"
3214
+ o.http_method = "POST"
3215
+ o.http_request_uri = "/"
3216
+ o.input = Shapes::ShapeRef.new(shape: UpdateUserPoolDomainRequest)
3217
+ o.output = Shapes::ShapeRef.new(shape: UpdateUserPoolDomainResponse)
3218
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
3219
+ o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
3220
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
3221
+ o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
3222
+ o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
3223
+ end)
3224
+
3202
3225
  api.add_operation(:verify_software_token, Seahorse::Model::Operation.new.tap do |o|
3203
3226
  o.name = "VerifySoftwareToken"
3204
3227
  o.http_method = "POST"
@@ -2619,7 +2619,20 @@ module Aws::CognitoIdentityProvider
2619
2619
  # @return [Array<String>]
2620
2620
  #
2621
2621
  # @!attribute [rw] write_attributes
2622
- # The write attributes.
2622
+ # The user pool attributes that the app client can write to.
2623
+ #
2624
+ # If your app client allows users to sign in through an identity
2625
+ # provider, this array must include all attributes that are mapped to
2626
+ # identity provider attributes. Amazon Cognito updates mapped
2627
+ # attributes when users sign in to your application through an
2628
+ # identity provider. If your app client lacks write access to a mapped
2629
+ # attribute, Amazon Cognito throws an error when it attempts to update
2630
+ # the attribute. For more information, see [Specifying Identity
2631
+ # Provider Attribute Mappings for Your User Pool][1].
2632
+ #
2633
+ #
2634
+ #
2635
+ # [1]: http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
2623
2636
  # @return [Array<String>]
2624
2637
  #
2625
2638
  # @!attribute [rw] explicit_auth_flows
@@ -2763,7 +2776,7 @@ module Aws::CognitoIdentityProvider
2763
2776
  # The configuration for a custom domain that hosts the sign-up and
2764
2777
  # sign-in webpages for your application.
2765
2778
  #
2766
- # Provide this parameter only if you want to use own custom domain for
2779
+ # Provide this parameter only if you want to use a custom domain for
2767
2780
  # your user pool. Otherwise, you can exclude this parameter and use
2768
2781
  # the Amazon Cognito hosted domain instead.
2769
2782
  #
@@ -5818,6 +5831,18 @@ module Aws::CognitoIdentityProvider
5818
5831
  #
5819
5832
  # @!attribute [rw] mutable
5820
5833
  # Specifies whether the value of the attribute can be changed.
5834
+ #
5835
+ # For any user pool attribute that's mapped to an identity provider
5836
+ # attribute, you must set this parameter to `true`. Amazon Cognito
5837
+ # updates mapped attributes when users sign in to your application
5838
+ # through an identity provider. If an attribute is immutable, Amazon
5839
+ # Cognito throws an error when it attempts to update the attribute.
5840
+ # For more information, see [Specifying Identity Provider Attribute
5841
+ # Mappings for Your User Pool][1].
5842
+ #
5843
+ #
5844
+ #
5845
+ # [1]: http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html
5821
5846
  # @return [Boolean]
5822
5847
  #
5823
5848
  # @!attribute [rw] required
@@ -6976,6 +7001,62 @@ module Aws::CognitoIdentityProvider
6976
7001
  include Aws::Structure
6977
7002
  end
6978
7003
 
7004
+ # The UpdateUserPoolDomain request input.
7005
+ #
7006
+ # @note When making an API call, you may pass UpdateUserPoolDomainRequest
7007
+ # data as a hash:
7008
+ #
7009
+ # {
7010
+ # domain: "DomainType", # required
7011
+ # user_pool_id: "UserPoolIdType", # required
7012
+ # custom_domain_config: { # required
7013
+ # certificate_arn: "ArnType", # required
7014
+ # },
7015
+ # }
7016
+ #
7017
+ # @!attribute [rw] domain
7018
+ # The domain name for the custom domain that hosts the sign-up and
7019
+ # sign-in pages for your application. For example: `auth.example.com`.
7020
+ #
7021
+ # This string can include only lowercase letters, numbers, and
7022
+ # hyphens. Do not use a hyphen for the first or last character. Use
7023
+ # periods to separate subdomain names.
7024
+ # @return [String]
7025
+ #
7026
+ # @!attribute [rw] user_pool_id
7027
+ # The ID of the user pool that is associated with the custom domain
7028
+ # that you are updating the certificate for.
7029
+ # @return [String]
7030
+ #
7031
+ # @!attribute [rw] custom_domain_config
7032
+ # The configuration for a custom domain that hosts the sign-up and
7033
+ # sign-in pages for your application. Use this object to specify an
7034
+ # SSL certificate that is managed by ACM.
7035
+ # @return [Types::CustomDomainConfigType]
7036
+ #
7037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolDomainRequest AWS API Documentation
7038
+ #
7039
+ class UpdateUserPoolDomainRequest < Struct.new(
7040
+ :domain,
7041
+ :user_pool_id,
7042
+ :custom_domain_config)
7043
+ include Aws::Structure
7044
+ end
7045
+
7046
+ # The UpdateUserPoolDomain response output.
7047
+ #
7048
+ # @!attribute [rw] cloud_front_domain
7049
+ # The Amazon CloudFront endpoint that Amazon Cognito set up when you
7050
+ # added the custom domain to your user pool.
7051
+ # @return [String]
7052
+ #
7053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolDomainResponse AWS API Documentation
7054
+ #
7055
+ class UpdateUserPoolDomainResponse < Struct.new(
7056
+ :cloud_front_domain)
7057
+ include Aws::Structure
7058
+ end
7059
+
6979
7060
  # Represents the request to update the user pool.
6980
7061
  #
6981
7062
  # @note When making an API call, you may pass UpdateUserPoolRequest
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-cognitoidentityprovider
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.11.0
4
+ version: 1.12.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: 2018-11-20 00:00:00.000000000 Z
11
+ date: 2018-12-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core