{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.cognitoidentityprovider#AWSAccountIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 12 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.cognitoidentityprovider#AWSCognitoIdentityProviderService": { "type": "service", "version": "2016-04-18", "operations": [ { "target": "com.amazonaws.cognitoidentityprovider#AddCustomAttributes" }, { "target": "com.amazonaws.cognitoidentityprovider#AddUserPoolClientSecret" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUp" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminDeleteSoftwareToken" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminDeleteUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminDeleteUserAttributes" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminDisableUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminEnableUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminForgetDevice" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminGetDevice" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminGetUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminGetUserAuthFactors" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminInitiateAuth" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminListDevices" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUser" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminListUserAuthEvents" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminListUserSessions" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminRemoveUserFromGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminResetUserPassword" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallenge" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminRevokeUserSession" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminSetUserMFAPreference" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminSetUserPassword" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminSetUserSettings" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedback" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateDeviceStatus" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributes" }, { "target": "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOut" }, { "target": "com.amazonaws.cognitoidentityprovider#AssociateSoftwareToken" }, { "target": "com.amazonaws.cognitoidentityprovider#CancelPointInTimeRecovery" }, { "target": "com.amazonaws.cognitoidentityprovider#ChangePassword" }, { "target": "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistration" }, { "target": "com.amazonaws.cognitoidentityprovider#ConfirmDevice" }, { "target": "com.amazonaws.cognitoidentityprovider#ConfirmForgotPassword" }, { "target": "com.amazonaws.cognitoidentityprovider#ConfirmSignUp" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateCIMDPolicy" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateIdentityProvider" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBranding" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateResourceServer" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateTerms" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateUserImportJob" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPool" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolClient" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomain" }, { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolReplica" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteCIMDPolicy" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteIdentityProvider" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBranding" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServer" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteTerms" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUser" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserAttributes" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPool" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClient" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientSecret" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomain" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolReplica" }, { "target": "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredential" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeCIMDPolicy" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeIdentityProvider" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBranding" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClient" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribePointInTimeRecovery" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeResourceServer" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeRiskConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeTerms" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeTermsByClient" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserImportJob" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPool" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPoolClient" }, { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPoolDomain" }, { "target": "com.amazonaws.cognitoidentityprovider#ForgetDevice" }, { "target": "com.amazonaws.cognitoidentityprovider#ForgotPassword" }, { "target": "com.amazonaws.cognitoidentityprovider#GetClientToken" }, { "target": "com.amazonaws.cognitoidentityprovider#GetCSVHeader" }, { "target": "com.amazonaws.cognitoidentityprovider#GetDerivedToken" }, { "target": "com.amazonaws.cognitoidentityprovider#GetDevice" }, { "target": "com.amazonaws.cognitoidentityprovider#GetGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifier" }, { "target": "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#GetProvisionedLimit" }, { "target": "com.amazonaws.cognitoidentityprovider#GetSigningCertificate" }, { "target": "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshToken" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUICustomization" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUser" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUserAttributeVerificationCode" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUserAuthFactors" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolClientSessionConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfig" }, { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolSessionConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#GlobalSignOut" }, { "target": "com.amazonaws.cognitoidentityprovider#InitiateAuth" }, { "target": "com.amazonaws.cognitoidentityprovider#InitiatePointInTimeRecovery" }, { "target": "com.amazonaws.cognitoidentityprovider#ListCIMDPolicies" }, { "target": "com.amazonaws.cognitoidentityprovider#ListClientMetadataURLs" }, { "target": "com.amazonaws.cognitoidentityprovider#ListDevices" }, { "target": "com.amazonaws.cognitoidentityprovider#ListGroups" }, { "target": "com.amazonaws.cognitoidentityprovider#ListIdentityProviders" }, { "target": "com.amazonaws.cognitoidentityprovider#ListPointInTimeRecoveries" }, { "target": "com.amazonaws.cognitoidentityprovider#ListResourceServers" }, { "target": "com.amazonaws.cognitoidentityprovider#ListTagsForResource" }, { "target": "com.amazonaws.cognitoidentityprovider#ListTerms" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserImportJobs" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolClients" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolClientSecrets" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolReplicas" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserPools" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUsers" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUserSessions" }, { "target": "com.amazonaws.cognitoidentityprovider#ListUsersInGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentials" }, { "target": "com.amazonaws.cognitoidentityprovider#ResendConfirmationCode" }, { "target": "com.amazonaws.cognitoidentityprovider#RespondToAuthChallenge" }, { "target": "com.amazonaws.cognitoidentityprovider#RevokeToken" }, { "target": "com.amazonaws.cognitoidentityprovider#RevokeUserSession" }, { "target": "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#SetRiskConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#SetUICustomization" }, { "target": "com.amazonaws.cognitoidentityprovider#SetUserMFAPreference" }, { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolClientSessionConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfig" }, { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolSessionConfiguration" }, { "target": "com.amazonaws.cognitoidentityprovider#SetUserSettings" }, { "target": "com.amazonaws.cognitoidentityprovider#SignUp" }, { "target": "com.amazonaws.cognitoidentityprovider#StartPointInTimeRecovery" }, { "target": "com.amazonaws.cognitoidentityprovider#StartUserImportJob" }, { "target": "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistration" }, { "target": "com.amazonaws.cognitoidentityprovider#StopUserImportJob" }, { "target": "com.amazonaws.cognitoidentityprovider#TagResource" }, { "target": "com.amazonaws.cognitoidentityprovider#UntagResource" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedback" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateCIMDPolicy" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateClientMetadataURLState" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateDeviceStatus" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateGroup" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateIdentityProvider" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBranding" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateProvisionedLimit" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateResourceServer" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateTerms" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserAttributes" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPool" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClient" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomain" }, { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolReplica" }, { "target": "com.amazonaws.cognitoidentityprovider#VerifySoftwareToken" }, { "target": "com.amazonaws.cognitoidentityprovider#VerifyUserAttribute" } ], "traits": { "aws.api#service": { "sdkId": "Cognito Identity Provider", "arnNamespace": "cognito-idp", "cloudFormationName": "Cognito", "cloudTrailEventSource": "cognito-idp.amazonaws.com", "docId": "cognito-idp-2016-04-18", "endpointPrefix": "cognito-idp" }, "aws.auth#sigv4": { "name": "cognito-idp" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "
With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To\n authenticate users from third-party identity providers (IdPs) in this API, you can\n link IdP users to native user profiles. Learn more\n about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and managed login reference.
\nThis API reference provides detailed information about API operations and object types\n in Amazon Cognito.
\nAlong with resource management operations, the Amazon Cognito user pools API includes classes\n of operations and authorization models for client-side and server-side authentication of\n users. You can interact with operations in the Amazon Cognito user pools API as any of the\n following subjects.
\nAn administrator who wants to configure user pools, app clients, users,\n groups, or other user pool functions.
\nA server-side app, like a web application, that wants to use its Amazon Web Services\n privileges to manage, authenticate, or authorize a user.
\nA client-side app, like a mobile app, that wants to make unauthenticated\n requests to manage, authenticate, or authorize a user.
\nFor more information, see Understanding API, OIDC, and managed login pages\n authentication in the Amazon Cognito Developer Guide.
\nWith your Amazon Web Services SDK, you can build the logic to support operational flows in every use\n case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started\n with the CognitoIdentityProvider client in supported Amazon Web Services SDKs.
To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services\n SDKs.
", "smithy.api#title": "Amazon Cognito Identity Provider", "smithy.api#xmlNamespace": { "uri": "http://cognito-idp.amazonaws.com/doc/2016-04-18/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-2" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-1" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-2" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.us-east-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.us-east-2.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.us-west-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.us-west-2.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 18, "nodes": "/////wAAAAH/////AAAAAAAAABEAAAADAAAAAQAAAAQF9eEQAAAAAgAAAAUF9eEQAAAAAwAAAAkAAAAGAAAABQAAAAcF9eEPAAAABgAAAAgF9eEOAAAABwX14QwF9eENAAAABAAAAAsAAAAKAAAABQX14QkF9eELAAAABQAAAAwF9eEKAAAABgAAAA0F9eEJAAAACAX14QQAAAAOAAAACQX14QUAAAAPAAAACgX14QYAAAAQAAAACwX14QcF9eEIAAAAAwX14QEAAAASAAAABQX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] } ], "endpoint": { "url": "https://cognito-idp-fips.us-east-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-2" ] } ], "endpoint": { "url": "https://cognito-idp-fips.us-east-2.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-1" ] } ], "endpoint": { "url": "https://cognito-idp-fips.us-west-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-2" ] } ], "endpoint": { "url": "https://cognito-idp-fips.us-west-2.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://cognito-idp.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://cognito-idp.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-south-2.amazonaws.com" } }, "params": { "Region": "ap-south-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ap-southeast-4.amazonaws.com" } }, "params": { "Region": "ap-southeast-4", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.ca-west-1.amazonaws.com" } }, "params": { "Region": "ca-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-central-2.amazonaws.com" } }, "params": { "Region": "eu-central-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-south-2.amazonaws.com" } }, "params": { "Region": "eu-south-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region il-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.il-central-1.amazonaws.com" } }, "params": { "Region": "il-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.me-central-1.amazonaws.com" } }, "params": { "Region": "me-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://cognito-idp.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.cognitoidentityprovider#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when you don't have sufficient permissions to perform the requested operation.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 86400 } } }, "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType": { "type": "structure", "members": { "RecoveryMechanisms": { "target": "com.amazonaws.cognitoidentityprovider#RecoveryMechanismsType", "traits": { "smithy.api#documentation": "The list of options and priorities for user message delivery in forgot-password\n operations. Sets or displays user pool preferences for email or SMS message priority,\n whether users should fall back to a second delivery method, and whether passwords should\n only be reset by administrators.
" } } }, "traits": { "smithy.api#documentation": "The settings for user message delivery in forgot-password operations. Contains\n preference for email or SMS message delivery of password reset codes, or for admin-only\n password reset.
" } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionNotifyType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType": { "type": "structure", "members": { "Notify": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionNotifyType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Determines whether Amazon Cognito sends a user a notification message when your user pools\n assesses a user's session at the associated risk level.
", "smithy.api#required": {} } }, "EventAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType", "traits": { "smithy.api#documentation": "The action to take for the attempted account takeover action for the associated risk\n level. Valid values are as follows:
\n\n BLOCK: Block the request.
\n MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is\n possible if the user pool has active MFA methods that the user can set up. For\n example, if the user pool only supports SMS message MFA but the user\n doesn't have a phone number attribute, MFA setup isn't possible. If MFA\n setup isn't possible, allow the request.
\n MFA_REQUIRED: Present an MFA challenge if possible. Block the\n request if a user hasn't set up MFA. To sign in with required MFA, users must\n have an email address or phone number attribute, or a registered TOTP\n factor.
\n NO_ACTION: Take no action. Permit sign-in.
The automated response to a risk level for adaptive authentication in full-function,\n or ENFORCED, mode. You can assign an action to each risk level that threat\n protection evaluates.
The action that you assign to a low-risk assessment by threat protection.
" } }, "MediumAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { "smithy.api#documentation": "The action that you assign to a medium-risk assessment by threat protection.
" } }, "HighAction": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverActionType", "traits": { "smithy.api#documentation": "The action that you assign to a high-risk assessment by threat protection.
" } } }, "traits": { "smithy.api#documentation": "A list of account-takeover actions for each level of risk that Amazon Cognito might assess with\n threat protection features.
" } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverEventActionType": { "type": "enum", "members": { "BLOCK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCK" } }, "MFA_IF_CONFIGURED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MFA_IF_CONFIGURED" } }, "MFA_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MFA_REQUIRED" } }, "NO_ACTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_ACTION" } } } }, "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType": { "type": "structure", "members": { "NotifyConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType", "traits": { "smithy.api#documentation": "The settings for composing and sending an email message when threat protection\n assesses a risk level with adaptive authentication. When you choose to notify users in\n AccountTakeoverRiskConfiguration, Amazon Cognito sends an email message using\n the method and template that you set with this data type.
A list of account-takeover actions for each level of risk that Amazon Cognito might assess with\n threat protection.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The settings for automated responses and notification templates for adaptive\n authentication with threat protection features.
" } }, "com.amazonaws.cognitoidentityprovider#AcrConfigurationType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#AcrLevelKeyType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#AcrLevelConfigType" }, "traits": { "smithy.api#documentation": "Defines the custom names that Amazon Cognito reports for the four fixed\n authentication context class reference (ACR) levels in a user pool. The map is keyed by\n level, from Level1 through Level4, and each value provides the\n custom name for that level. Amazon Cognito reports the name of the level that a user\n meets in the acr token claim.
The custom name for this authentication context class reference (ACR) level. This\n value is the URI that Amazon Cognito reports in the acr token claim when a\n user meets this level. The name must be unique across all levels in the user pool,\n including default names.
The configuration for a single authentication context class reference (ACR) level in a user pool. Each entry in an AcrConfiguration map associates a level (Level1 through Level4) with this configuration, which provides the custom name that Amazon Cognito reports for that level in the acr token claim.
A map between the authentication context class reference (ACR) levels of a user pool\n and the ACR values of an external OpenID Connect (OIDC) identity provider (IdP), so that\n your application gets a consistent step-up experience regardless of which IdP\n authenticated the user. The map is keyed by level, from Level1 through\n Level4, and each value is the ACR value that the IdP uses for the\n corresponding level.
Adds additional user attributes to the user pool schema. Custom attributes can be\n mutable or immutable and have a custom: or dev: prefix. For\n more information, see Custom attributes.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to add custom attributes.
", "smithy.api#required": {} } }, "CustomAttributes": { "target": "com.amazonaws.cognitoidentityprovider#CustomAttributesListType", "traits": { "smithy.api#documentation": "An array of custom attribute names and other properties. Sets the following\n characteristics:
\nThe expected data type. Can be a string, a number, a date and time, or a\n boolean.
\nIf true, you can grant app clients write access to the attribute value. If\n false, the attribute value can only be set up on sign-up or administrator\n creation of users.
\nThe attribute name. For an attribute like custom:myAttribute,\n enter myAttribute for this field.
When true, users who sign up or are created must set a value for the\n attribute.
\nThe minimum and maximum length of accepted values for a\n Number-type attribute.
The minimum and maximum length of accepted values for a\n String-type attribute.
This legacy option creates an attribute with a dev: prefix.\n You can only set the value of a developer-only attribute with administrative\n IAM credentials.
Represents the request to add custom attributes.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AddCustomAttributesResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server for the request to add custom\n attributes.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AddUserPoolClientSecret": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AddUserPoolClientSecretRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AddUserPoolClientSecretResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AccessDeniedException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalServerException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates a new client secret for an existing confidential user pool app client. Supports up to 2 active secrets per app client for zero-downtime credential rotation workflows.
" } }, "com.amazonaws.cognitoidentityprovider#AddUserPoolClientSecretRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the app client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client for which you want to create a new secret.
", "smithy.api#required": {} } }, "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { "smithy.api#documentation": "The client secret value you want to use. If you don't provide this parameter, Amazon Cognito generates a secure secret for you.
" } } }, "traits": { "smithy.api#documentation": "The request to create a new client secret for a user pool app client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AddUserPoolClientSecretResponse": { "type": "structure", "members": { "ClientSecretDescriptor": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretDescriptorType", "traits": { "smithy.api#documentation": "The details of the newly created client secret, including its unique identifier and creation timestamp. The ClientSecretValue is only returned when Amazon Cognito generates the secret. For custom secrets that you provide, the ClientSecretValue is not included in the response.
" } } }, "traits": { "smithy.api#documentation": "The response from creating a new client secret.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroup": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminAddUserToGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Adds a user to a group. A user who is in a group can present a preferred-role claim to\n an identity pool, and populates a cognito:groups claim to their access and\n identity tokens.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the group that you want to add the user\n to.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The name of the group that you want to add your user to.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUp": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUpRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUpResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyFailedAttemptsException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Confirms user sign-up as an administrator.
\nThis request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can\n configure your user pool to not send confirmation codes to new users and instead confirm\n them with this API operation on the back end.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nTo configure your user pool to require administrative confirmation of users, set\n AllowAdminCreateUserOnly to true in a\n CreateUserPool or UpdateUserPool request.
The ID of the user pool where you want to confirm a user's sign-up\n request.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Confirm a user's registration as a user pool administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminConfirmSignUpResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server for the request to confirm\n registration.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PreconditionNotMetException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnsupportedUserStateException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UsernameExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Creates a new user in the specified user pool.
\nIf MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).
This message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.
\nAlternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, if the user has a password, they will be in the\n FORCE_CHANGE_PASSWORD state until they sign in and set their password.\n Your invitation message template must have the {####} password placeholder\n if your users have passwords. If your template doesn't have this placeholder, Amazon Cognito\n doesn't deliver the invitation message. In this case, you must update your message\n template and resend the password with a new AdminCreateUser request with a\n MessageAction value of RESEND.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe setting for allowing self-service sign-up. When true, only\n administrators can create new user profiles. When false, users can register\n themselves and create a new user profile with the SignUp operation.
This parameter is no longer in use.
\nThe password expiration limit in days for administrator-created users. When this time\n expires, the user can't sign in with their temporary password. To reset the account\n after that time limit, you must call AdminCreateUser again, specifying\n RESEND for the MessageAction parameter.
The default value for this parameter is 7.
" } }, "InviteMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#MessageTemplateType", "traits": { "smithy.api#documentation": "The template for the welcome message to new users. This template must include the\n {####} temporary password placeholder if you are creating users with\n passwords. If your users don't have passwords, you can omit the placeholder.
See also Customizing User Invitation Messages.
" } } }, "traits": { "smithy.api#documentation": "The settings for administrator creation of users in a user pool. Contains settings for\n allowing user sign-up, customizing invitation messages to new users, and the amount of\n time before temporary passwords expire.
" } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to create a user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The value that you want to set as the username sign-in attribute. The following\n conditions apply to the username parameter.
\nThe username can't be a duplicate of another username in the same user\n pool.
\nYou can't change the value of a username after you create it.
\nYou can only provide a value if usernames are a valid sign-in attribute for\n your user pool. If your user pool only supports phone numbers or email addresses\n as sign-in attributes, Amazon Cognito automatically generates a username value. For more\n information, see Customizing sign-in attributes.
\nAn array of name-value pairs that contain user attributes and attribute values to be\n set for the user to be created. You can create a user without specifying any attributes\n other than Username. However, any attributes that you specify as required\n (when creating a user pool or in the Attributes tab of\n the console) either you should supply (in your call to AdminCreateUser) or\n the user should supply (when they sign up in response to your welcome message).
For custom attributes, you must prepend the custom: prefix to the\n attribute name.
To send a message inviting the user to sign up, you must specify the user's email\n address or phone number. You can do this in your call to AdminCreateUser or in the\n Users tab of the Amazon Cognito console for managing your\n user pools.
\nYou must also provide an email address or phone number when you expect the user to do\n passwordless sign-in with an email or SMS OTP. These attributes must be provided when\n passwordless options are the only available, or when you don't submit a\n TemporaryPassword.
In your AdminCreateUser request, you can set the\n email_verified and phone_number_verified attributes to\n true. The following conditions apply:
The email address where you want the user to receive their confirmation\n code and username. You must provide a value for email when you\n want to set email_verified to true, or if you set\n EMAIL in the DesiredDeliveryMediums\n parameter.
The phone number where you want the user to receive their confirmation\n code and username. You must provide a value for phone_number\n when you want to set phone_number_verified to\n true, or if you set SMS in the\n DesiredDeliveryMediums parameter.
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda\n trigger. This set of key-value pairs are for custom validation of information that you \n collect from your users but don't need to retain.
\nYour Lambda function can analyze this additional data and act on it. Your function\n can automatically confirm and verify select users or perform external API operations \n like logging user attributes and validation data to Amazon CloudWatch Logs.
\nFor more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
" } }, "TemporaryPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { "smithy.api#documentation": "The user's temporary password. This password must conform to the password policy that\n you specified when you created the user pool.
\nThe exception to the requirement for a password is when your user pool supports\n passwordless sign-in with email or SMS OTPs. To create a user with no password, omit\n this parameter or submit a blank value. You can only create a passwordless user when\n passwordless sign-in is available.
\nThe temporary password is valid only once. To complete the Admin Create User flow, the\n user must enter the temporary password in the sign-in page, along with a new password to\n be used in all future sign-ins.
\nIf you don't specify a value, Amazon Cognito generates one for you unless you have passwordless\n options active for your user pool.
\nThe temporary password can only be used until the user account expiration limit that\n you set for your user pool. To reset the account after that time limit, you must call\n AdminCreateUser again and specify RESEND for the\n MessageAction parameter.
This parameter is used only if the phone_number_verified or\n email_verified attribute is set to True. Otherwise, it is\n ignored.
If this parameter is set to True and the phone number or email address\n specified in the UserAttributes parameter already exists as an alias with a\n different user, this request migrates the alias from the previous user to the\n newly-created user. The previous user will no longer be able to log in using that\n alias.
If this parameter is set to False, the API throws an\n AliasExistsException error if the alias already exists. The default\n value is False.
Set to RESEND to resend the invitation message to a user that already\n exists, and to reset the temporary-password duration with a new temporary password. Set\n to SUPPRESS to suppress sending the message. You can specify only one\n value.
Specify EMAIL if email will be used to send the welcome message. Specify\n SMS if the phone number will be used. The default value is\n SMS. You can specify more than one value.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Creates a new user in the specified user pool.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserResponse": { "type": "structure", "members": { "User": { "target": "com.amazonaws.cognitoidentityprovider#UserType", "traits": { "smithy.api#documentation": "The new user's profile details.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to create the user.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminCreateUserUnusedAccountValidityDaysType": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 365 } } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteSoftwareToken": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminDeleteSoftwareTokenRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminDeleteSoftwareTokenResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes a user's registered time-based one-time password (TOTP) multi-factor\n authentication (MFA) factor, also known as a software token. After this operation, the\n user can no longer sign in with TOTP MFA, and can register a new TOTP factor with\n AssociateSoftwareToken. Use this operation when a user loses access to\n their TOTP-generating device, for example, a lost or reset phone, and needs to register\n a new one.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to delete the user's software\n token.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Deletes a user profile in your user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nDeletes attribute values from a user. This operation doesn't affect tokens for\n existing user sessions. The next ID token that the user receives will no longer have the\n deleted attributes.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to delete user attributes.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
An array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name.
Represents the request to delete user attributes as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteUserAttributesResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response received from the server for a request to delete user\n attributes.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminDeleteUserRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to delete the user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Represents the request to delete a user as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Prevents the user from signing in with the specified external (SAML or social)\n identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools\n native username + password user, they can't use their password to sign in. If the user\n to deactivate is a linked external IdP user, any link between that user and an existing\n user is removed. When the external user signs in again, and the user is no longer\n attached to the previously linked DestinationUser, the user must create a\n new user account.
The value of ProviderName must match the name of a user pool IdP.
To deactivate a local user, set ProviderName to Cognito and\n the ProviderAttributeName to Cognito_Subject. The\n ProviderAttributeValue must be user's local username.
The ProviderAttributeName must always be Cognito_Subject for\n social IdPs. The ProviderAttributeValue must always be the exact subject\n that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has\n not yet been used to sign in, the ProviderAttributeName and\n ProviderAttributeValue must be the same values that were used for the\n SourceUser when the identities were originally linked using \n AdminLinkProviderForUser call. This is also true if the linking was done with\n ProviderAttributeName set to Cognito_Subject. If the user\n has already signed in, the ProviderAttributeName must be\n Cognito_Subject and ProviderAttributeValue must be the\n NameID from their SAML assertion.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to delete the user's linked\n identities.
", "smithy.api#required": {} } }, "User": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { "smithy.api#documentation": "The user profile that you want to delete a linked identity from.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminDisableProviderForUserResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminDisableUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminDisableUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminDisableUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Deactivates a user profile and revokes all access tokens for the user. A deactivated\n user can't sign in, but still appears in the responses to ListUsers\n API requests.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to disable the user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Represents the request to disable the user as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminDisableUserResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response received from the server to disable the user as an\n administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminEnableUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminEnableUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminEnableUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Activates sign-in for a user profile that previously had sign-in access\n disabled.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to activate sign-in for the user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Represents the request that enables the user as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminEnableUserResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server for the request to enable a user as an\n administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminForgetDevice": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminForgetDeviceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Forgets, or deletes, a remembered device from a user's profile. After you forget\n the device, the user can no longer complete device authentication with that device and\n when applicable, must submit MFA codes again. For more information, see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where the device owner is a user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The key ID of the device that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Sends the forgot device request, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminGetDevice": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminGetDeviceRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminGetDeviceResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given the device key, returns details for a user's device. For more information,\n see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe key of the device that you want to delete.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where the device owner is a user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Represents the request to get the device, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminGetDeviceResponse": { "type": "structure", "members": { "Device": { "target": "com.amazonaws.cognitoidentityprovider#DeviceType", "traits": { "smithy.api#documentation": "Details of the requested device. Includes device information, last-accessed and\n created dates, and the device key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Gets the device response, as an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminGetUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminGetUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminGetUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Given a username, returns details about a user profile in a user pool. You can specify\n alias attributes in the Username request parameter.
This operation contributes to your monthly active user (MAU) count for the purpose of\n billing.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nLists the authentication options for a user in a user pool. Returns the\n following:
\nThe user's multi-factor authentication (MFA) preferences.
\nThe user's options for choice-based authentication with the\n USER_AUTH flow.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to get information about the user's\n authentication factors.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The name of the user who is eligible for the authentication factors in the\n response.
", "smithy.api#required": {} } }, "PreferredMfaSetting": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The challenge method that Amazon Cognito returns to the user in response to sign-in requests.\n Users can prefer SMS message, email message, or TOTP MFA.
" } }, "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.
The authentication types that are available to the user with USER_AUTH\n sign-in, for example [\"PASSWORD\", \"WEB_AUTHN\"].
\n PASSWORD can only be used as a first authentication factor.\n SOFTWARE_TOKEN can only be used as an MFA factor.\n EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be\n used as either a first authentication factor or an MFA factor. WEB_AUTHN\n is available as an MFA factor only when passkey MFA is enabled at the user pool\n level.
The ID of the user pool where you want to get information about the user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Represents the request to get the specified user as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminGetUserResponse": { "type": "structure", "members": { "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The username of the user that you requested.
", "smithy.api#required": {} } }, "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { "smithy.api#documentation": "An array of name-value pairs of user attributes and their values, for example\n \"email\": \"testuser@example.com\".
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
Indicates whether the user is activated for sign-in.
" } }, "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { "smithy.api#documentation": "The user's status. Can be one of the following:
\nUNCONFIRMED - User has been created but not confirmed.
\nCONFIRMED - User has been confirmed.
\nUNKNOWN - User status isn't known.
\nRESET_REQUIRED - User is confirmed, but the user must request a code and reset\n their password before they can sign in.
\nFORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a\n temporary password, but on first sign-in, the user must change their password to\n a new value before doing anything else.
\nEXTERNAL_PROVIDER - The user signed in with a third-party identity\n provider.
\n\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about\n time-based one-time password (TOTP) software token MFA configurations. To look up\n information about either type of MFA configuration, use UserMFASettingList\n instead.
" } }, "PreferredMfaSetting": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The user's preferred MFA. Users can prefer SMS message, email message, or TOTP\n MFA.
" } }, "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.
Represents the response from the server from the request to get the specified user as\n an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuth": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#MFAMethodNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnsupportedOperationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Starts sign-in for applications with a server-side component, for example a\n traditional web application. This operation specifies the authentication flow that\n you'd like to begin. The authentication flow that you specify must be supported in\n your app client configuration. For more information about authentication flows, see\n Authentication flows.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where the user wants to sign in.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client where the user wants to sign in.
", "smithy.api#required": {} } }, "AuthFlow": { "target": "com.amazonaws.cognitoidentityprovider#AuthFlowType", "traits": { "smithy.api#documentation": "The authentication flow that you want to initiate. Each AuthFlow has\n linked AuthParameters that you must submit. The following are some example\n flows.
The entry point for choice-based authentication with passwords,\n one-time passwords, and WebAuthn authenticators. Request a preferred\n authentication type or review available authentication types. From the\n offered authentication types, select one in a challenge response and then\n authenticate with that method in an additional challenge response.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
\nUsername-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.
\nReceive new ID and access tokens when you pass a\n REFRESH_TOKEN parameter with a valid refresh token as the\n value. For more information, see Using the refresh token.
Custom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.
\nServer-side username-password authentication with the password sent\n directly in the request. For more information about client-side and\n server-side authentication, see SDK authorization models.
\nThe authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking.
The following are some authentication flows and their parameters. Add a\n SECRET_HASH parameter if your app client has a client secret. Add\n DEVICE_KEY if you want to bypass multi-factor authentication with a\n remembered device.
\n USERNAME (required)
\n PREFERRED_CHALLENGE. If you don't provide a\n value for PREFERRED_CHALLENGE, Amazon Cognito responds with the\n AvailableChallenges parameter that specifies the\n available sign-in methods.
\n TARGET_ACR_VALUES. An optional, space-separated list\n of the authentication context class reference (ACR) level URIs that\n you want the user to reach. List the levels in priority order, from\n highest to lowest. Amazon Cognito attempts the highest-priority level that the\n user can satisfy, and falls back through the list. Amazon Cognito ignores any\n value that it doesn't recognize. If none of the requested values are\n valid, Amazon Cognito returns an error.
Requesting step-up authentication with this parameter requires the\n Essentials or Plus feature plan. On a lower feature plan,\n AdminInitiateAuth returns a FeatureUnavailableInTierException.\n USERNAME is required. When you provide an\n ACCESS_TOKEN, you must also provide\n TARGET_ACR_VALUES. Amazon Cognito returns an error if you provide\n an ACCESS_TOKEN without TARGET_ACR_VALUES.\n The USERNAME that you provide must match the user that the\n ACCESS_TOKEN was issued for.
For more information about step-up authentication and how Amazon Cognito\n handles multi-factor authentication requirements, see Step-up\n authentication with ACR and AMR in the Amazon Cognito\n Developer Guide.
\n\n MAX_AGE. An optional integer that sets the maximum\n number of seconds allowed since the user last authenticated. If the\n user's most recent authentication is older than this value, Amazon Cognito\n discards the authentication-methods credit from any access token that\n you provide and processes the request as a fresh authentication toward\n the target level. The access token itself remains valid.
\n USERNAME (required)
\n SRP_A (required)
\n USERNAME (required)
\n PASSWORD (required)
\n REFRESH_TOKEN(required)
\n USERNAME (required)
\n ChallengeName: SRP_A (when preceding custom\n authentication with SRP authentication)
\n SRP_A: (An SRP_A value) (when preceding custom\n authentication with SRP authentication)
For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nThe ClientMetadata value is passed as input to the functions for only the\n following triggers:
Pre signup
\nPre authentication
\nUser migration
\nThis request also invokes the functions for the following triggers, but doesn't pass\n ClientMetadata:
Post authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nCustom email sender
\nCustom SMS sender
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "ContextData": { "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "The optional session ID from a ConfirmSignUp API request. You can sign in\n a user directly from the sign-up process with an AuthFlow of\n USER_AUTH and AuthParameters of EMAIL_OTP or\n SMS_OTP, depending on how your user pool sent the confirmation-code\n message.
Initiates the authorization request, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminInitiateAuthResponse": { "type": "structure", "members": { "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "The name of the challenge that you're responding to with this call. This is returned\n in the AdminInitiateAuth response if you must pass another\n challenge.
Possible challenges include the following:
\nAll of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.
\n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.
\n PASSWORD: Respond with the user's password as PASSWORD.
\n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.
\n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.
\n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n
\n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n
\n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .
\n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.
\n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.
\n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.
\n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.
\n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.
\n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.
Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.
\nIn a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.
To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n
To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n
The session that must be passed to challenge-response requests. If an\n AdminInitiateAuth or AdminRespondToAuthChallenge API\n request results in another authentication challenge, Amazon Cognito returns a session ID and the\n parameters of the next challenge. Pass this session ID in the Session\n parameter of AdminRespondToAuthChallenge.
The parameters of an authentication challenge. Amazon Cognito returns challenge parameters as a\n guide to the responses your user or application must provide for the returned\n ChallengeName. Calculate responses to the challenge parameters and pass\n them in the ChallengeParameters of\n AdminRespondToAuthChallenge.
All challenges require USERNAME and, when the app client has a client\n secret, SECRET_HASH.
In SRP challenges, Amazon Cognito returns the username attribute in\n USER_ID_FOR_SRP instead of any email address, preferred username, or\n phone number alias that you might have specified in your AdminInitiateAuth\n request. You must use the username and not an alias in the\n ChallengeResponses of your challenge response.
The outcome of successful authentication. This is only returned if the user pool has\n no additional challenges to return. If Amazon Cognito returns another challenge, the response\n includes ChallengeName, ChallengeParameters, and\n Session so that your user can answer the challenge.
This response parameter lists the available authentication challenges that users can\n select from in choice-based authentication. For example, they might be\n able to choose between passkey authentication, a one-time password from an SMS message,\n and a traditional password.
" } } }, "traits": { "smithy.api#documentation": "Initiates the authentication response, as an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminLinkProviderForUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Links an existing user account in a user pool, or DestinationUser, to an\n identity from an external IdP, or SourceUser, based on a specified\n attribute name and value from the external IdP.
This operation connects a local user profile with a user identity who hasn't yet\n signed in from their third-party IdP. When the user signs in with their IdP, they get\n access-control configuration from the local user profile. Linked local users can also\n sign in with SDK-based API operations like InitiateAuth after they sign in\n at least once through their IdP. For more information, see Linking federated users.
The maximum number of federated identities linked to a user is five.
\nBecause this API allows a user with an external federated identity to sign in as a\n local user, it is critical that it only be used with external IdPs and linked\n attributes that you trust.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to link a federated identity.
", "smithy.api#required": {} } }, "DestinationUser": { "target": "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType", "traits": { "smithy.api#documentation": "The existing user in the user pool that you want to assign to the external IdP user\n account. This user can be a local (Username + Password) Amazon Cognito user pools user or a\n federated user (for example, a SAML or Facebook user). If the user doesn't exist, Amazon Cognito\n generates an exception. Amazon Cognito returns this user when the new user (with the linked IdP\n attribute) signs in.
\nFor a native username + password user, the ProviderAttributeValue for the\n DestinationUser should be the username in the user pool. For a\n federated user, it should be the provider-specific user_id.
The ProviderAttributeName of the DestinationUser is\n ignored.
The ProviderName should be set to Cognito for users in\n Cognito user pools.
An external IdP account for a user who doesn't exist yet in the user pool. This user\n must be a federated user (for example, a SAML or Facebook user), not another native\n user.
\nIf the SourceUser is using a federated social IdP, such as Facebook,\n Google, or Login with Amazon, you must set the ProviderAttributeName to\n Cognito_Subject. For social IdPs, the ProviderName will be\n Facebook, Google, or LoginWithAmazon, and\n Amazon Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for\n id, sub, and user_id, respectively. The\n ProviderAttributeValue for the user must be the same value as the\n id, sub, or user_id value found in the social\n IdP token.
For OIDC, the ProviderAttributeName can be any mapped value from a claim\n in the ID token, or that your app retrieves from the userInfo endpoint. For\n SAML, the ProviderAttributeName can be any mapped value from a claim in the\n SAML assertion.
The following additional considerations apply to SourceUser for OIDC and\n SAML providers.
You must map the claim to a user pool attribute in your IdP configuration, and\n set the user pool attribute name as the value of\n ProviderAttributeName in your\n AdminLinkProviderForUser request. For example,\n email.
When you set ProviderAttributeName to\n Cognito_Subject, Amazon Cognito will automatically parse the default\n unique identifier found in the subject from the IdP token.
Lists a user's registered devices. Remembered devices are used in authentication\n services where you offer a \"Remember me\" option for users who you want to permit to sign\n in without MFA from a trusted device. Users can bypass MFA while your application\n performs device SRP authentication on the back end. For more information, see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where the device owner is a user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The maximum number of devices that you want Amazon Cognito to return in the response.
" } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the request to list devices, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListDevicesResponse": { "type": "structure", "members": { "Devices": { "target": "com.amazonaws.cognitoidentityprovider#DeviceListType", "traits": { "smithy.api#documentation": "An array of devices and their information. Each entry that's returned includes\n device information, last-accessed and created dates, and the device key.
" } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Lists the device's response, as an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the groups that a user belongs to. User pool groups are identifiers that you can\n reference from the contents of ID and access tokens, and set preferred IAM roles for\n identity-pool authentication. For more information, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The ID of the user pool where you want to view a user's groups.
", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of groups that you want Amazon Cognito to return in the response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListGroupsForUserResponse": { "type": "structure", "members": { "Groups": { "target": "com.amazonaws.cognitoidentityprovider#GroupListType", "traits": { "smithy.api#documentation": "An array of groups and information about them.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListUserAuthEvents": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminListUserAuthEventsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminListUserAuthEventsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnNotEnabledException" } ], "traits": { "smithy.api#documentation": "Requests a history of user activity and any risks detected as part of Amazon Cognito threat\n protection. For more information, see Viewing user event history.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe Id of the user pool that contains the user profile with the logged events.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The maximum number of authentication events to return. Returns 60 events if you set\n MaxResults to 0, or if you don't include a MaxResults\n parameter.
This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListUserAuthEventsResponse": { "type": "structure", "members": { "AuthEvents": { "target": "com.amazonaws.cognitoidentityprovider#AuthEventsType", "traits": { "smithy.api#documentation": "The response object. It includes the EventID, EventType,\n CreationDate, EventRisk, and\n EventResponse.
The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListUserSessions": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminListUserSessionsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminListUserSessionsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the active sessions for a specified user as an administrator. The response\n includes both token sessions and SSO sessions. Only active sessions are returned;\n revoked and expired sessions aren't included. Amazon Cognito returns all of a user's sessions in\n a single page of up to 125 sessions. The results are eventually consistent, and new\n sessions are typically included within a few seconds.
", "smithy.api#examples": [ { "title": "Example list the active sessions of a user as an administrator", "documentation": "The following example lists the active sessions for the user testuser. The response contains one token session that originated from an SSO session, and the SSO session it came through.", "input": { "UserPoolId": "us-east-1_EXAMPLE", "Username": "testuser" }, "output": { "Sessions": [ { "SessionId": "tkna7b3c9d2e5f8g1h4j6k0m2n5p", "SessionType": "TOKEN", "ClientId": "1example23456789", "CreateDate": 1792454400.117, "LastActiveDate": 1792540800.234, "DeviceType": "Chrome 125 / macOS 15.0", "LastIPAddress": "192.0.2.42", "LastLocation": { "City": "Seattle", "Country": "United States" }, "OriginSessionId": "ssoq4r8s2t6u9v3w7x1y5z0a2b4c", "IsCurrentSession": false }, { "SessionId": "ssoq4r8s2t6u9v3w7x1y5z0a2b4c", "SessionType": "SSO", "ClientId": "1example23456789", "CreateDate": 1792368000.351, "LastActiveDate": 1792537200.468, "DeviceType": "Chrome 125 / macOS 15.0", "LastIPAddress": "192.0.2.42", "LastLocation": { "City": "Seattle", "Country": "United States" }, "IsCurrentSession": false } ] } } ], "smithy.api#readonly": {} } }, "com.amazonaws.cognitoidentityprovider#AdminListUserSessionsRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The username of the user whose sessions you want to list.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "A pagination token that Amazon Cognito returned in a previous response. Use this value to\n retrieve the next page of results if a NextToken was included in a prior\n response.
A list of the user's active sessions. Each element describes one token session or SSO\n session.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The pagination token to use in a subsequent request to retrieve the next page of\n results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminRemoveUserFromGroup": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminRemoveUserFromGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Given a username and a group name, removes them from the group. User pool groups are\n identifiers that you can reference from the contents of ID and access tokens, and set\n preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the group and the user that you want to\n remove.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The name of the group that you want to remove the user from, for example\n MyTestGroup.
Begins the password reset process. Sets the requested user\u2019s account into a\n RESET_REQUIRED status, and sends them a password-reset code. Your user\n pool also sends the user a notification with a reset code and the information that their\n password has been reset. At sign-in, your application or the managed login session\n receives a challenge to complete the reset by confirming the code and setting a new\n password.
To use this API operation, your user pool must have self-service account recovery\n configured.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to reset the user's password.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to reset a user's password as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminResetUserPasswordResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server to reset a user password as an\n administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallenge": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#ExpiredCodeException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#MFAMethodNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordHistoryPolicyViolationException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFANotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Some API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. An AdminRespondToAuthChallenge API request provides the answer\n to that challenge, like a code or a secure remote password (SRP). The parameters of a\n response to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to respond to an authentication\n challenge.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client where you initiated sign-in.
", "smithy.api#required": {} } }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "The name of the challenge that you are responding to.
\nPossible challenges include the following:
\nAll of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.
\n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.
\n PASSWORD: Respond with the user's password as PASSWORD.
\n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.
\n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.
\n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n
\n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n
\n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .
\n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.
\n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.
\n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.
\n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.
\n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.
\n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.
Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.
\nIn a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.
To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n
To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n
The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.
\nYou must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n
Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.
Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n
For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"WEB_AUTHN\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n
\n \"ChallengeName\": \"PASSWORD\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n
\n \"ChallengeName\": \"PASSWORD_SRP\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n
\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n
This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.
\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n
\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n
To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n
\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n
\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n
\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]\"}\n
For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.
The session identifier that maintains the state of authentication requests and\n challenge responses. If an AdminInitiateAuth or\n AdminRespondToAuthChallenge API request results in a determination that\n your application must pass another challenge, Amazon Cognito returns a session with other\n challenge parameters. Send this session identifier, unmodified, to the next\n AdminRespondToAuthChallenge request.
Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "ContextData": { "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
The request to respond to the authentication challenge, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminRespondToAuthChallengeResponse": { "type": "structure", "members": { "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "The name of the next challenge that you must respond to.
\nPossible challenges include the following:
\nAll of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.
\n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.
\n PASSWORD: Respond with the user's password as PASSWORD.
\n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.
\n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.
\n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n
\n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n
\n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .
\n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.
\n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.
\n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.
\n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.
\n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.
\n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.
Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.
\nIn a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.
To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n
To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n
The session identifier that maintains the state of authentication requests and\n challenge responses. If an AdminInitiateAuth or\n AdminRespondToAuthChallenge API request results in a determination that\n your application must pass another challenge, Amazon Cognito returns a session with other\n challenge parameters. Send this session identifier, unmodified, to the next\n AdminRespondToAuthChallenge request.
The parameters that define your response to the next challenge.
" } }, "AuthenticationResult": { "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", "traits": { "smithy.api#documentation": "The outcome of a successful authentication process. After your application has passed\n all challenges, Amazon Cognito returns an AuthenticationResult with the JSON web\n tokens (JWTs) that indicate successful sign-in.
This response parameter lists the available authentication challenges that users can\n select from in choice-based authentication. For example, they might be\n able to choose between passkey authentication, a one-time password from an SMS message,\n and a traditional password.
" } } }, "traits": { "smithy.api#documentation": "Responds to the authentication challenge, as an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminRevokeUserSession": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminRevokeUserSessionRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminRevokeUserSessionResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Revokes a specific user session as an administrator. Amazon Cognito revokes all refresh and\n access tokens that are associated with the session and deletes the session record. You\n can revoke either a token session or an SSO session, and you can optionally cascade the\n revocation to linked sessions.
", "smithy.api#examples": [ { "title": "Example revoke a user session as an administrator", "documentation": "The following example revokes a token session for the user testuser and cascades the revocation to the parent SSO session that the token session came through.", "input": { "UserPoolId": "us-east-1_EXAMPLE", "Username": "testuser", "SessionId": "tknm5k9p2q7r4s8t1v6w3x0y5z2b", "RevokeAssociatedSessions": "LINKED" }, "output": {} } ] } }, "com.amazonaws.cognitoidentityprovider#AdminRevokeUserSessionRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the session.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The username of the user who owns the session. The username must match the user\n associated with the SessionId, to confirm they are the intended target\n user.
The ID of the session to revoke. This is a 28-character string of lowercase letters\n and digits, prefixed with tkn for a token session or sso for\n an SSO session.
Specifies whether to also revoke the sessions that are linked to the targeted session.\n NONE, the default, revokes only the targeted session. LINKED\n also revokes the directly linked session or sessions, interpreted relative to the type\n of the targeted session: revoking a token session also revokes the parent SSO session it\n came through, and revoking an SSO session also revokes the token sessions that came\n through it. The set of linked sessions is eventually consistent, so associated\n sessions are typically revoked within a few seconds.
Sets the user's multi-factor authentication (MFA) preference, including which MFA\n options are activated, and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nUser preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as\n the preferred MFA method when multiple methods are available.
" } }, "SoftwareTokenMfaSettings": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", "traits": { "smithy.api#documentation": "User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates\n TOTP MFA and sets it as the preferred MFA method when multiple methods are\n available.
" } }, "EmailMfaSettings": { "target": "com.amazonaws.cognitoidentityprovider#EmailMfaSettingsType", "traits": { "smithy.api#documentation": "User preferences for email message MFA. Activates or deactivates email MFA and sets it\n as the preferred MFA method when multiple methods are available.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "WebAuthnMfaSettings": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnMfaSettingsType", "traits": { "smithy.api#documentation": "User preferences for passkey MFA. Activates or deactivates passkey MFA for the user.\n When activated, passkey authentication requires user verification, and passkey sign-in\n is available when MFA is required. To activate this setting, the\n FactorConfiguration of your user pool WebAuthnConfiguration\n must be MULTI_FACTOR_WITH_USER_VERIFICATION.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The ID of the user pool where you want to set a user's MFA preferences.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserMFAPreferenceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserPassword": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminSetUserPasswordRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminSetUserPasswordResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordHistoryPolicyViolationException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Sets the specified user's password in a user pool. This operation administratively\n sets a temporary or permanent password for a user. With this operation, you can bypass\n self-service password changes and permit immediate sign-in with the password that you\n set. To do this, set Permanent to true.
You can also set a new temporary password in this request, send it to a user, and\n require them to choose a new password on their next sign-in. To do this, set\n Permanent to false.
If the password is temporary, the user's Status becomes\n FORCE_CHANGE_PASSWORD. When the user next tries to sign in, the\n InitiateAuth or AdminInitiateAuth response includes the\n NEW_PASSWORD_REQUIRED challenge. If the user doesn't sign in\n before the temporary password expires, they can no longer sign in and you must repeat\n this operation to set a temporary or permanent password for them.
After the user sets a new password, or if you set a permanent password, their status\n becomes Confirmed.
\n AdminSetUserPassword can set a password for the user profile that Amazon Cognito\n creates for third-party federated users. When you set a password, the federated user's\n status changes from EXTERNAL_PROVIDER to CONFIRMED. A user in\n this state can sign in as a federated user, and initiate authentication flows in the API\n like a linked native user. They can also modify their password and attributes in\n token-authenticated API requests like ChangePassword and\n UpdateUserAttributes. As a best security practice and to keep users in\n sync with your external IdP, don't set passwords on federated user profiles. To set up a\n federated user for native sign-in with a linked native user, refer to Linking federated users to an existing user\n profile.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to set the user's password.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The new temporary or permanent password that you want to set for the user. You\n can't remove the password for a user who already has a password so that they can\n only sign in with passwordless methods. In this scenario, you must create a new user\n without a password.
", "smithy.api#required": {} } }, "Permanent": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Set to true to set a password that the user can immediately sign in with.\n Set to false to set a temporary password that the user must change on their\n next sign-in.
\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token MFA.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the user whose options you're setting.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
You can use this parameter only to set an SMS configuration that uses SMS for\n delivery.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "You can use this parameter to set an MFA configuration that uses the SMS delivery\n medium.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminSetUserSettingsResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server to set user settings as an\n administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedback": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedbackRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateAuthEventFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnNotEnabledException" } ], "traits": { "smithy.api#documentation": "Provides the feedback for an authentication event generated by threat protection\n features. Your response indicates that you think that the event either was from a valid\n user or was an unwanted authentication attempt. This feedback improves the risk\n evaluation decision for the user pool as part of Amazon Cognito threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.
\nTo train the threat-protection model to recognize trusted and untrusted sign-in\n characteristics, configure threat protection in audit-only mode and provide a mechanism\n for users or administrators to submit feedback. Your feedback can tell Amazon Cognito that a risk\n rating was assigned at a level you don't agree with.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to submit authentication-event feedback.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The ID of the threat protection authentication event that you want to update.
", "smithy.api#required": {} } }, "FeedbackValue": { "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", "traits": { "smithy.api#documentation": "Your feedback to the authentication event. When you provide a FeedbackValue\nvalue of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito\nhas evaluated some level of risk. When you provide a FeedbackValue value of\ninvalid, you tell Amazon Cognito that you don't trust a user session, or you \ndon't believe that Amazon Cognito evaluated a high-enough risk level.
Updates the status of a user's device so that it is marked as remembered or not\n remembered for the purpose of device authentication. Device authentication is a\n \"remember me\" mechanism that silently completes sign-in from trusted devices with a\n device key instead of a user-provided MFA code. This operation changes the status of a\n device without deleting it, so you can enable it again later. For more information about\n device authentication, see Working with devices.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to change a user's device status.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The unique identifier, or device key, of the device that you want to update the status\n for.
", "smithy.api#required": {} } }, "DeviceRememberedStatus": { "target": "com.amazonaws.cognitoidentityprovider#DeviceRememberedStatusType", "traits": { "smithy.api#documentation": "To enable device authentication with the specified device, set to\n remembered.To disable, set to not_remembered.
The request to update the device status, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateDeviceStatusResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The status response to the request to update the device, as an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributes": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Updates the specified user's attributes. To delete an attribute from your user,\n submit the attribute in your API request with a blank value.
\nFor custom attributes, you must add a custom: prefix to the attribute\n name, for example custom:department.
This operation can set a user's email address or phone number as verified and\n permit immediate sign-in in user pools that require verification of these attributes. To\n do this, set the email_verified or phone_number_verified\n attribute to true.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe ID of the user pool where you want to update user attributes.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
An array of name-value pairs representing user attributes.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name.
If your user pool requires verification before Amazon Cognito updates an attribute value that\n you specify in this request, Amazon Cognito doesn\u2019t immediately update the value of that\n attribute. After your user receives and responds to a verification message to verify the\n new value, Amazon Cognito updates the attribute value. Your user can sign in and receive messages\n with the original attribute value until they verify the new value.
\nTo skip the verification message and update the value of an attribute that requires\n verification in the same API request, include the email_verified or\n phone_number_verified attribute, with a value of true. If\n you set the email_verified or phone_number_verified value for\n an email or phone_number attribute that requires verification\n to true, Amazon Cognito doesn\u2019t send a verification message to your user.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to update the user's attributes as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminUpdateUserAttributesResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server for the request to update user attributes as\n an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOut": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOutRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOutResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call\n this operation with your administrative credentials when your user signs out of your\n app. This results in the following behavior.
\nAmazon Cognito no longer accepts token-authorized user operations\n that you authorize with a signed-out user's access tokens. For more information,\n see Using the Amazon Cognito user pools API and user pool\n endpoints.
\nAmazon Cognito returns an Access Token has been revoked error when your\n app attempts to authorize a user pools API request with a revoked access token\n that contains the scope aws.cognito.signin.user.admin.
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with\n ServerSideTokenCheck enabled for its user pool IdP\n configuration in CognitoIdentityProvider.
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh\n requests.
\nOther requests might be valid until your user's token expires. This operation\n doesn't clear the managed login session cookie. To clear the session for\n a user who signed in with managed login or the classic hosted UI, direct their browser\n session to the logout endpoint.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to sign out a user.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The request to sign out of all devices, as an administrator.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#AdminUserGlobalSignOutResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The global sign-out response, as an administrator.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AdvancedSecurityAdditionalFlowsType": { "type": "structure", "members": { "CustomAuthMode": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityEnabledModeType", "traits": { "smithy.api#documentation": "The operating mode of threat protection in custom authentication with Custom\n authentication challenge Lambda triggers.
" } } }, "traits": { "smithy.api#documentation": "Threat protection configuration options for additional authentication types in your\n user pool, including custom\n authentication.
" } }, "com.amazonaws.cognitoidentityprovider#AdvancedSecurityEnabledModeType": { "type": "enum", "members": { "AUDIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUDIT" } }, "ENFORCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENFORCED" } } } }, "com.amazonaws.cognitoidentityprovider#AdvancedSecurityModeType": { "type": "enum", "members": { "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } }, "AUDIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUDIT" } }, "ENFORCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENFORCED" } } } }, "com.amazonaws.cognitoidentityprovider#AliasAttributeType": { "type": "enum", "members": { "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "phone_number" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "email" } }, "PREFERRED_USERNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "preferred_username" } } } }, "com.amazonaws.cognitoidentityprovider#AliasAttributesListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AliasAttributeType" } }, "com.amazonaws.cognitoidentityprovider#AliasExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message that Amazon Cognito sends to the user when the value of an alias attribute is\n already linked to another user profile.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user tries to confirm the account with an email\n address or phone number that has already been supplied as an alias for a different user\n profile. This exception indicates that an account with this email address or phone\n already exists in a user pool that you've configured to use email address or phone\n number as a sign-in alias.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#AllowedFirstAuthFactorsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AuthFactorType" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.cognitoidentityprovider#AnalyticsConfigurationType": { "type": "structure", "members": { "ApplicationId": { "target": "com.amazonaws.cognitoidentityprovider#HexStringType", "traits": { "smithy.api#documentation": "Your Amazon Pinpoint project ID.
" } }, "ApplicationArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Pinpoint project that you want to connect to\n your user pool app client. Amazon Cognito publishes events to the Amazon Pinpoint project that\n ApplicationArn declares. You can also configure your application to\n pass an endpoint ID in the AnalyticsMetadata parameter of sign-in\n operations. The endpoint ID is information about the destination for push\n notifications
The ARN of an Identity and Access Management role that has the permissions required for Amazon Cognito to publish\n events to Amazon Pinpoint analytics.
" } }, "ExternalId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The external ID of the role that Amazon Cognito assumes to send\n analytics data to Amazon Pinpoint.
" } }, "UserDataShared": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If UserDataShared is true, Amazon Cognito includes user data in the\n events that it publishes to Amazon Pinpoint analytics.
The settings for Amazon Pinpoint analytics configuration. With an analytics configuration,\n your application can collect user-activity metrics for user notifications with a Amazon Pinpoint\n campaign.
\nAmazon Pinpoint isn't available in all Amazon Web Services Regions. For a list of available Regions, see\n Amazon Cognito and Amazon Pinpoint Region availability.
" } }, "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType": { "type": "structure", "members": { "AnalyticsEndpointId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The endpoint ID. Information that you want to pass to Amazon Pinpoint about where to send\n notifications.
" } } }, "traits": { "smithy.api#documentation": "Information that your application adds to authentication requests. Applies an endpoint\n ID to the analytics data that your user pool sends to Amazon Pinpoint.
\nAn endpoint ID uniquely identifies a mobile device, email address or phone number that\n can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that\n can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
" } }, "com.amazonaws.cognitoidentityprovider#ArnType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?$" } }, "com.amazonaws.cognitoidentityprovider#AssetBytesType": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 1000000 } } }, "com.amazonaws.cognitoidentityprovider#AssetCategoryType": { "type": "enum", "members": { "FAVICON_ICO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAVICON_ICO" } }, "FAVICON_SVG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAVICON_SVG" } }, "EMAIL_GRAPHIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL_GRAPHIC" } }, "SMS_GRAPHIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS_GRAPHIC" } }, "AUTH_APP_GRAPHIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTH_APP_GRAPHIC" } }, "PASSWORD_GRAPHIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSWORD_GRAPHIC" } }, "PASSKEY_GRAPHIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSKEY_GRAPHIC" } }, "PAGE_HEADER_LOGO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAGE_HEADER_LOGO" } }, "PAGE_HEADER_BACKGROUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAGE_HEADER_BACKGROUND" } }, "PAGE_FOOTER_LOGO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAGE_FOOTER_LOGO" } }, "PAGE_FOOTER_BACKGROUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAGE_FOOTER_BACKGROUND" } }, "PAGE_BACKGROUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAGE_BACKGROUND" } }, "FORM_BACKGROUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FORM_BACKGROUND" } }, "FORM_LOGO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FORM_LOGO" } }, "IDP_BUTTON_ICON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDP_BUTTON_ICON" } } } }, "com.amazonaws.cognitoidentityprovider#AssetExtensionType": { "type": "enum", "members": { "ICO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ICO" } }, "JPEG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JPEG" } }, "PNG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PNG" } }, "SVG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SVG" } }, "WEBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEBP" } } } }, "com.amazonaws.cognitoidentityprovider#AssetListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AssetType" }, "traits": { "smithy.api#length": { "min": 0, "max": 40 } } }, "com.amazonaws.cognitoidentityprovider#AssetType": { "type": "structure", "members": { "Category": { "target": "com.amazonaws.cognitoidentityprovider#AssetCategoryType", "traits": { "smithy.api#documentation": "The category that the image corresponds to in your managed login configuration.\n Managed login has asset categories for different types of logos, backgrounds, and\n icons.
", "smithy.api#required": {} } }, "ColorMode": { "target": "com.amazonaws.cognitoidentityprovider#ColorSchemeModeType", "traits": { "smithy.api#documentation": "The display-mode target of the asset: light, dark, or browser-adaptive. For example,\n Amazon Cognito displays a dark-mode image only when the browser or application is in dark mode,\n but displays a browser-adaptive file in all contexts.
", "smithy.api#required": {} } }, "Extension": { "target": "com.amazonaws.cognitoidentityprovider#AssetExtensionType", "traits": { "smithy.api#documentation": "The file type of the image file.
", "smithy.api#required": {} } }, "Bytes": { "target": "com.amazonaws.cognitoidentityprovider#AssetBytesType", "traits": { "smithy.api#documentation": "The image file, in Base64-encoded binary.
" } }, "ResourceId": { "target": "com.amazonaws.cognitoidentityprovider#ResourceIdType", "traits": { "smithy.api#documentation": "The ID of the asset.
" } } }, "traits": { "smithy.api#documentation": "An image file from a managed login branding style in a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#AssociateSoftwareToken": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFANotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Begins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
You can provide either an access token or a session ID in the request.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "The session identifier that maintains the state of authentication requests and\n challenge responses. In AssociateSoftwareToken, this is the session ID from\n a successful sign-in. You can provide either an access token or a session ID in the\n request.
A unique generated shared secret code that is used by the TOTP algorithm to generate a\n one-time code.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "The session identifier that maintains the state of authentication requests and\n challenge responses.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#AttributeDataType": { "type": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "String" } }, "NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Number" } }, "DATETIME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DateTime" } }, "BOOLEAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Boolean" } } } }, "com.amazonaws.cognitoidentityprovider#AttributeListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AttributeType" } }, "com.amazonaws.cognitoidentityprovider#AttributeMappingKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 } } }, "com.amazonaws.cognitoidentityprovider#AttributeMappingType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#AttributeMappingKeyType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#AttributeNameListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType" } }, "com.amazonaws.cognitoidentityprovider#AttributeNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+$" } }, "com.amazonaws.cognitoidentityprovider#AttributeType": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", "traits": { "smithy.api#documentation": "The name of the attribute, for example email or\n custom:department.
In some older user pools, the regex pattern for acceptable values of this parameter is\n [\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+. Older pools will eventually be updated to\n use the new pattern. Affected user pools are those created before May 2024 in\n US East (N. Virginia), US East (Ohio), US West (N. California), US West (Oregon),\n Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), Canada (Central),\n Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris),\n Europe (Stockholm), Middle East (Bahrain), and South America (S\u00e3o Paulo).
The value of the attribute.
" } } }, "traits": { "smithy.api#documentation": "The name and value of a user attribute.
" } }, "com.amazonaws.cognitoidentityprovider#AttributeValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#AttributesRequireVerificationBeforeUpdateType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributeType" } }, "com.amazonaws.cognitoidentityprovider#AudienceListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AudienceType" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.cognitoidentityprovider#AudienceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$" } }, "com.amazonaws.cognitoidentityprovider#AuthEventType": { "type": "structure", "members": { "EventId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The event ID.
" } }, "EventType": { "target": "com.amazonaws.cognitoidentityprovider#EventType", "traits": { "smithy.api#documentation": "The type of authentication event.
" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The event response.
" } }, "EventRisk": { "target": "com.amazonaws.cognitoidentityprovider#EventRiskType", "traits": { "smithy.api#documentation": "The threat evaluation from your user pool about an event. Contains information about\n whether your user pool detected compromised credentials, whether the event triggered an\n automated response, and the level of risk.
" } }, "ChallengeResponses": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponseListType", "traits": { "smithy.api#documentation": "A list of the challenges that the user was requested to answer, for example\n Password, and the result, for example Success.
The user context data captured at the time of an event request. This value provides\n additional information about the client from which event the request is received.
" } }, "EventFeedback": { "target": "com.amazonaws.cognitoidentityprovider#EventFeedbackType", "traits": { "smithy.api#documentation": "The UpdateAuthEventFeedback or AdminUpdateAuthEventFeedback\n feedback that you or your user provided in response to the event. A value of\n Valid indicates that you disagreed with the level of risk that your\n user pool assigned, and evaluated a session to be valid, or likely safe. A value of\n Invalid indicates that you agreed with the user pool risk level and\n evaluated a session to be invalid, or likely malicious.
One authentication event that Amazon Cognito logged in a user pool with threat protection\n active. Contains user and device metadata and a risk assessment from your user\n pool.
" } }, "com.amazonaws.cognitoidentityprovider#AuthEventsType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AuthEventType" } }, "com.amazonaws.cognitoidentityprovider#AuthFactorType": { "type": "enum", "members": { "PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSWORD" } }, "EMAIL_OTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL_OTP" } }, "SMS_OTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS_OTP" } }, "WEB_AUTHN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEB_AUTHN" } }, "SOFTWARE_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOFTWARE_TOKEN" } } } }, "com.amazonaws.cognitoidentityprovider#AuthFlowType": { "type": "enum", "members": { "USER_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_SRP_AUTH" } }, "REFRESH_TOKEN_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REFRESH_TOKEN_AUTH" } }, "REFRESH_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REFRESH_TOKEN" } }, "CUSTOM_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_AUTH" } }, "ADMIN_NO_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADMIN_NO_SRP_AUTH" } }, "USER_PASSWORD_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_PASSWORD_AUTH" } }, "ADMIN_USER_PASSWORD_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADMIN_USER_PASSWORD_AUTH" } }, "USER_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_AUTH" } } } }, "com.amazonaws.cognitoidentityprovider#AuthParametersType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#AuthSessionValidityType": { "type": "integer", "traits": { "smithy.api#range": { "min": 3, "max": 15 } } }, "com.amazonaws.cognitoidentityprovider#AuthenticationResultType": { "type": "structure", "members": { "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "Your user's access token.
" } }, "ExpiresIn": { "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The expiration period of the authentication result in seconds.
" } }, "TokenType": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The intended use of the token, for example Bearer.
Your user's refresh token.
" } }, "IdToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "Your user's ID token.
" } }, "NewDeviceMetadata": { "target": "com.amazonaws.cognitoidentityprovider#NewDeviceMetadataType", "traits": { "smithy.api#documentation": "The new device metadata from an authentication result.
" } } }, "traits": { "smithy.api#documentation": "The object that your application receives after authentication. Contains tokens and\n information for device authentication.
" } }, "com.amazonaws.cognitoidentityprovider#AvailableChallengeListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType" } }, "com.amazonaws.cognitoidentityprovider#BlockedIPRangeListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.cognitoidentityprovider#BooleanType": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.cognitoidentityprovider#CIMDCacheActionType": { "type": "enum", "members": { "REFRESH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REFRESH" } }, "INVALIDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALIDATE" } } } }, "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.cognitoidentityprovider#CIMDPolicyNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\p{Z}]+$" } }, "com.amazonaws.cognitoidentityprovider#CIMDPolicySummaryListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicySummaryType" } }, "com.amazonaws.cognitoidentityprovider#CIMDPolicySummaryType": { "type": "structure", "members": { "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that the CIMD policy is associated with. Amazon Cognito\n omits this value when the app client no longer exists.
" } }, "PolicyName": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyNameType", "traits": { "smithy.api#documentation": "The friendly name of the CIMD policy.
", "smithy.api#required": {} } }, "CacheDuration": { "target": "com.amazonaws.cognitoidentityprovider#CacheDurationType", "traits": { "smithy.api#documentation": "The length of time, in seconds, that Amazon Cognito caches a client metadata document\n that it retrieved from a URL that matches the policy.
" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the CIMD policy was created.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the CIMD policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "A summary of a Client ID Metadata Document (CIMD) policy, returned by .
" } }, "com.amazonaws.cognitoidentityprovider#CIMDPolicyType": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the CIMD policy.
", "smithy.api#required": {} } }, "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that the CIMD policy is associated with. Amazon Cognito\n omits this value when the app client no longer exists.
" } }, "PolicyName": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyNameType", "traits": { "smithy.api#documentation": "The friendly name of the CIMD policy.
", "smithy.api#required": {} } }, "CacheDuration": { "target": "com.amazonaws.cognitoidentityprovider#CacheDurationType", "traits": { "smithy.api#documentation": "The length of time, in seconds, that Amazon Cognito caches a client metadata document\n that it retrieved from a URL that matches the policy.
" } }, "URLPatterns": { "target": "com.amazonaws.cognitoidentityprovider#URLPatternListType", "traits": { "smithy.api#documentation": "The HTTPS URL patterns that a client ID metadata document URL must match.
" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the CIMD policy was created.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the CIMD policy was last modified.
" } } }, "traits": { "smithy.api#documentation": "The configuration of a Client ID Metadata Document (CIMD) policy.
" } }, "com.amazonaws.cognitoidentityprovider#CSSType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 131072 } } }, "com.amazonaws.cognitoidentityprovider#CSSVersionType": { "type": "string" }, "com.amazonaws.cognitoidentityprovider#CacheDurationType": { "type": "integer", "traits": { "smithy.api#range": { "min": 86400, "max": 31556952 } } }, "com.amazonaws.cognitoidentityprovider#CachedCIMDURLDoesNotExistException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito doesn't have a cached client metadata\n document for the URL in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cognitoidentityprovider#CallbackURLsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.cognitoidentityprovider#CancelPointInTimeRecovery": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CancelPointInTimeRecoveryRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CancelPointInTimeRecoveryResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Cancels a point-in-time recovery of a user pool before Amazon Cognito applies any changes.\n You can cancel a recovery when its status is PREVIEW_GENERATING or\n PREVIEW_GENERATED. When you cancel a recovery, Amazon Cognito discards the\n recovery preview, resumes write operations in the user pool, and sets the status of\n the recovery to PREVIEW_CANCELLED. Your user pool data doesn't\n change.
You can't cancel a recovery after you start it with a request.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the recovery that you want to cancel.
", "smithy.api#required": {} } }, "RestoreId": { "target": "com.amazonaws.cognitoidentityprovider#RestoreIdType", "traits": { "smithy.api#documentation": "The ID of the recovery that you want to cancel. Amazon Cognito returns this ID in the\n response to an InitiatePointInTimeRecovery request.
The details of the canceled recovery, including its status.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ChallengeName": { "type": "enum", "members": { "Password": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Password" } }, "Mfa": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Mfa" } } } }, "com.amazonaws.cognitoidentityprovider#ChallengeNameType": { "type": "enum", "members": { "SMS_MFA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS_MFA" } }, "EMAIL_OTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL_OTP" } }, "SOFTWARE_TOKEN_MFA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOFTWARE_TOKEN_MFA" } }, "SELECT_MFA_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELECT_MFA_TYPE" } }, "MFA_SETUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MFA_SETUP" } }, "PASSWORD_VERIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSWORD_VERIFIER" } }, "CUSTOM_CHALLENGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_CHALLENGE" } }, "SELECT_CHALLENGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELECT_CHALLENGE" } }, "DEVICE_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEVICE_SRP_AUTH" } }, "DEVICE_PASSWORD_VERIFIER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEVICE_PASSWORD_VERIFIER" } }, "ADMIN_NO_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADMIN_NO_SRP_AUTH" } }, "NEW_PASSWORD_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEW_PASSWORD_REQUIRED" } }, "SMS_OTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS_OTP" } }, "PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSWORD" } }, "WEB_AUTHN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEB_AUTHN" } }, "PASSWORD_SRP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSWORD_SRP" } } } }, "com.amazonaws.cognitoidentityprovider#ChallengeParametersType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#ChallengeResponse": { "type": "enum", "members": { "Success": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Success" } }, "Failure": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failure" } } } }, "com.amazonaws.cognitoidentityprovider#ChallengeResponseListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeResponseType" } }, "com.amazonaws.cognitoidentityprovider#ChallengeResponseType": { "type": "structure", "members": { "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeName", "traits": { "smithy.api#documentation": "The type of challenge that your previous authentication request returned in the\n parameter ChallengeName, for example SMS_MFA.
The set of key-value pairs that provides a response to the requested challenge.
" } } }, "traits": { "smithy.api#documentation": "The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.
\nYou must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n
Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.
Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n
For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"WEB_AUTHN\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n
\n \"ChallengeName\": \"PASSWORD\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n
\n \"ChallengeName\": \"PASSWORD_SRP\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n
\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n
This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.
\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n
\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n
To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n
\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n
\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n
\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]\"}\n
For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.
Changes the password for the currently signed-in user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe user's previous password. Required if the user has a password. If the user\n has no password and only signs in with passwordless authentication options, you can omit\n this parameter.
" } }, "ProposedPassword": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { "smithy.api#documentation": "A new password that you prompted the user to enter in your application.
", "smithy.api#required": {} } }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user whose password you want to\n change.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to change a user password.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ChangePasswordResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response from the server to the change password request.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ClientAuthenticationResultType": { "type": "structure", "members": { "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "The access token for the requested app client. Present this token to a resource server\n to authorize a request, using the scopes granted in the token.
" } }, "ExpiresIn": { "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of seconds until the access token expires.
" } }, "TokenType": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The type of the token. For example, Bearer.
The access token and its metadata from a machine-to-machine (M2M) client credentials\n grant.
" } }, "com.amazonaws.cognitoidentityprovider#ClientIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#ClientMetadataType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#ClientMetadataURLListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataURLType" }, "traits": { "smithy.api#length": { "min": 0, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#ClientMetadataURLType": { "type": "structure", "members": { "URL": { "target": "com.amazonaws.cognitoidentityprovider#MetadataURLType", "traits": { "smithy.api#documentation": "The client metadata document URL.
", "smithy.api#required": {} } }, "CachedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when Amazon Cognito cached the client metadata document from this\n URL.
" } }, "ExpirationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the cached client metadata document expires.
" } } }, "traits": { "smithy.api#documentation": "A client metadata document URL that Amazon Cognito has received for a Client ID\n Metadata Document (CIMD) policy, with its cache state.
" } }, "com.amazonaws.cognitoidentityprovider#ClientNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w\\s+=,.@-]+$" } }, "com.amazonaws.cognitoidentityprovider#ClientPermissionListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionType" } }, "com.amazonaws.cognitoidentityprovider#ClientPermissionType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.cognitoidentityprovider#ClientSSOSessionConfigType": { "type": "structure", "members": { "MaxValidityMinutes": { "target": "com.amazonaws.cognitoidentityprovider#SSOSessionMaxValidityMinutesType", "traits": { "smithy.api#documentation": "The maximum amount of time, in minutes, that this app client silently reuses an\n existing SSO session, returning a new set of tokens without requiring the user to\n re-authenticate, measured from the user's last fresh authentication. The minimum value\n is 0 and the maximum value is 129600 (90 days). The default is\n 60. A value of 0 means that this app client never silently\n reuses the SSO session and always re-authenticates the user. The SSO session record and\n its cookie are still created regardless of this value, and other app clients in the same\n user pool can still reuse the session.
The SSO session settings for a user pool app client.
" } }, "com.amazonaws.cognitoidentityprovider#ClientSecretArnType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn\\:(aws|aws-us-gov|aws-eusc)\\:secretsmanager\\:([\\d\\w\\-]+):(\\d{12})\\:secret\\/[\\w+=\\/,.@\\-]+$" } }, "com.amazonaws.cognitoidentityprovider#ClientSecretDescriptorListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretDescriptorType" }, "traits": { "smithy.api#documentation": "Contains metadata about a client secret for list operations. This type excludes the actual secret value for security reasons.
" } }, "com.amazonaws.cognitoidentityprovider#ClientSecretDescriptorType": { "type": "structure", "members": { "ClientSecretId": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretIdType", "traits": { "smithy.api#documentation": "The unique identifier for the client secret. This identifier follows the format
The actual secret value. This is only returned when creating a new secret and only if Amazon Cognito generated the secret. For custom secrets that you provide, this field is not included in the response.
" } }, "ClientSecretCreateDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the client secret was created.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a client secret, including its unique identifier, value, and creation timestamp.
" } }, "com.amazonaws.cognitoidentityprovider#ClientSecretIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.cognitoidentityprovider#ClientSecretType": { "type": "string", "traits": { "smithy.api#length": { "min": 24, "max": 64 }, "smithy.api#pattern": "^[\\w+]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#ClientTypeType": { "type": "enum", "members": { "REGULAR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REGULAR" } }, "DCR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DCR" } } } }, "com.amazonaws.cognitoidentityprovider#CloudWatchLogsConfigurationType": { "type": "structure", "members": { "LogGroupArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\n The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account\n as your user pool.
\nTo send logs to log groups with a resource policy of a size greater than 5120\n characters, configure a log group with a path that starts with\n /aws/vendedlogs. For more information, see Enabling\n logging from certain Amazon Web Services services.
Configuration for the CloudWatch log group destination of user pool detailed activity\n logging, or of user activity log export with threat protection.
" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType": { "type": "structure", "members": { "Destination": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The email address or phone number destination where Amazon Cognito sent the code.
" } }, "DeliveryMedium": { "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType", "traits": { "smithy.api#documentation": "The method that Amazon Cognito used to send the code.
" } }, "AttributeName": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType", "traits": { "smithy.api#documentation": "The name of the attribute that Amazon Cognito verifies with the code.
" } } }, "traits": { "smithy.api#documentation": "The delivery details for an email or SMS message that Amazon Cognito sent for authentication or\n verification.
" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message sent when a verification code fails to deliver successfully.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a verification code fails to deliver\n successfully.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#CodeMismatchException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message provided when the code mismatch exception is thrown.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown if the provided code doesn't match what the server was\n expecting.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#ColorSchemeModeType": { "type": "enum", "members": { "LIGHT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LIGHT" } }, "DARK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DARK" } }, "DYNAMIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DYNAMIC" } } } }, "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnChallengeNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnClientMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialNotSupportedException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnOriginNotAllowedException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnRelyingPartyMismatchException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Completes registration of a passkey authenticator for the currently signed-in\n user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
A RegistrationResponseJSON public-key credential response from the\n user's passkey provider.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CompleteWebAuthnRegistrationResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CompletionMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w]+$" } }, "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsActionsType": { "type": "structure", "members": { "EventAction": { "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsEventActionType", "traits": { "smithy.api#documentation": "The action that Amazon Cognito takes when it detects compromised credentials.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Settings for user pool actions when Amazon Cognito detects compromised credentials with threat\n protection in full-function ENFORCED mode.
Settings for the sign-in activity where you want to configure compromised-credentials\n actions. Defaults to all events.
" } }, "Actions": { "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsActionsType", "traits": { "smithy.api#documentation": "Settings for the actions that you want your user pool to take when Amazon Cognito detects\n compromised credentials.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Settings for compromised-credentials actions and authentication-event sources with\n threat protection in full-function ENFORCED mode.
The message provided when the concurrent exception is thrown.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown if two or more modifications are happening\n concurrently.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#ConfiguredUserAuthFactorsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AuthFactorType" }, "traits": { "smithy.api#length": { "min": 0, "max": 8 } } }, "com.amazonaws.cognitoidentityprovider#ConfirmDevice": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmDeviceRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmDeviceResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UsernameExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Confirms a device that a user wants to remember. A remembered device is a \"Remember me\n on this device\" option for user pools that perform authentication with the device key of\n a trusted device in the back end, instead of a user-provided MFA code. For more\n information about device authentication, see Working with user devices in your user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The unique identifier, or device key, of the device that you want to update the status\n for.
", "smithy.api#required": {} } }, "DeviceSecretVerifierConfig": { "target": "com.amazonaws.cognitoidentityprovider#DeviceSecretVerifierConfigType", "traits": { "smithy.api#documentation": "The configuration of the device secret verifier.
" } }, "DeviceName": { "target": "com.amazonaws.cognitoidentityprovider#DeviceNameType", "traits": { "smithy.api#documentation": "A friendly name for the device, for example MyMobilePhone.
The confirm-device request.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ConfirmDeviceResponse": { "type": "structure", "members": { "UserConfirmationNecessary": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, your user must confirm that they want to remember the device.\n Prompt the user for an answer.
When false, immediately sets the device as remembered and eligible for\n device authentication.
You can configure your user pool to always remember devices, in which case this\n response is false, or to allow users to opt in, in which case this response\n is true. Configure this option under Device tracking\n in the Sign-in menu of your user pool.
The confirm-device response.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ConfirmForgotPassword": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmForgotPasswordRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmForgotPasswordResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#ExpiredCodeException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordHistoryPolicyViolationException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyFailedAttemptsException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "This public API operation accepts a confirmation code that Amazon Cognito sent to a user and\n accepts a new password for that user.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe ID of the app client where the user wants to reset their password. This parameter\n is an identifier of the client application that users are resetting their password from,\n but this operation resets users' irrespective of the app clients they sign in\n to.
", "smithy.api#required": {} } }, "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash, see Computing secret hash values.
The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The confirmation code that your user pool delivered when your user requested to reset\n their password.
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { "smithy.api#documentation": "The new password that your user wants to set.
", "smithy.api#required": {} } }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { "smithy.api#documentation": "Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
The request representing the confirmation for a password reset.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ConfirmForgotPasswordResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response from the server that results from a user's request to retrieve a\n forgotten password.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ConfirmSignUp": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmSignUpRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmSignUpResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#ExpiredCodeException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyFailedAttemptsException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Confirms the account of a new user. This public API operation submits a code that\n Amazon Cognito sent to your user when they signed up in your user pool. After your user enters\n their code, they confirm ownership of the email address or phone number that they\n provided, and their user account becomes active. Depending on your user pool\n configuration, your users will receive their confirmation code in an email or SMS\n message.
\nLocal users who signed up in your user pool are the only type of user who can confirm\n sign-up with a code. Users who federate through an external identity provider (IdP) have\n already been confirmed by their IdP.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe ID of the app client associated with the user pool.
", "smithy.api#required": {} } }, "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash, see Computing secret hash values.
The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The confirmation code that your user pool sent in response to the SignUp\n request.
When true, forces user confirmation despite any existing aliases.\n Defaults to false. A value of true migrates the alias from an\n existing user to the new user if an existing user already has the phone number or email\n address as an alias.
Say, for example, that an existing user has an email attribute of\n bob@example.com and email is an alias in your user pool. If the new\n user also has an email of bob@example.com and your\n ConfirmSignUp response sets ForceAliasCreation to\n true, the new user can sign in with a username of\n bob@example.com and the existing user can no longer do so.
If false and an attribute belongs to an existing alias, this request\n returns an AliasExistsException error.
For more information about sign-in aliases, see Customizing sign-in attributes.
" } }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { "smithy.api#documentation": "Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
The optional session ID from a SignUp API request. You can sign in a user\n directly from the sign-up process with the USER_AUTH authentication\n flow.
Represents the request to confirm registration of a user.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ConfirmSignUpResponse": { "type": "structure", "members": { "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "A session identifier that you can use to immediately sign in the confirmed user. You\n can automatically sign users in with the one-time password that they provided in a\n successful ConfirmSignUp request.
Represents the response from the server for the registration confirmation.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ConfirmationCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.cognitoidentityprovider#ContextDataType": { "type": "structure", "members": { "IpAddress": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The source IP address of your user's device.
", "smithy.api#required": {} } }, "ServerName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The name of your application's service endpoint.
", "smithy.api#required": {} } }, "ServerPath": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The path of your application's service endpoint.
", "smithy.api#required": {} } }, "HttpHeaders": { "target": "com.amazonaws.cognitoidentityprovider#HttpHeaderList", "traits": { "smithy.api#documentation": "The HTTP headers from your user's authentication request.
", "smithy.api#required": {} } }, "EncodedData": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "Encoded device-fingerprint details that your app collected with the Amazon Cognito\n context data collection library. For more information, see Adding user device and session data to API requests.
" } } }, "traits": { "smithy.api#documentation": "Contextual user data used for evaluating the risk of an authentication event by user\n pool threat protection.
" } }, "com.amazonaws.cognitoidentityprovider#CreateCIMDPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateCIMDPolicyRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateCIMDPolicyResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates a Client ID Metadata Document (CIMD) policy for an app client. A CIMD policy\n lets OAuth clients identify themselves to your user pool with an HTTPS URL as their\n client ID. Amazon Cognito retrieves the client metadata document from that URL and\n accepts the client only when the URL matches one of the URL patterns in the\n policy.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to create the CIMD policy.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to associate with the CIMD policy.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyNameType", "traits": { "smithy.api#documentation": "A friendly name for the CIMD policy.
", "smithy.api#required": {} } }, "CacheDuration": { "target": "com.amazonaws.cognitoidentityprovider#CacheDurationType", "traits": { "smithy.api#documentation": "The length of time, in seconds, that Amazon Cognito caches a client metadata document\n that it retrieved from a URL that matches the policy. The value must be between 86,400\n seconds (one day) and 31,556,952 seconds (one year).
" } }, "URLPatterns": { "target": "com.amazonaws.cognitoidentityprovider#URLPatternListType", "traits": { "smithy.api#documentation": "One to five HTTPS URL patterns. Amazon Cognito accepts a client ID metadata document\n URL only when it matches one of these patterns. Patterns can contain the *\n wildcard character.
The CIMD policy that you created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateGroup": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateGroupRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateGroupResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#GroupExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates a new group in the specified user pool. For more information about user pool\n groups, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nA name for the group. This name must be unique in your user pool.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to create a user group.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.cognitoidentityprovider#DescriptionType", "traits": { "smithy.api#documentation": "A description of the group that you're creating.
" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM role that you want to associate with the\n group. A group role primarily declares a preferred role for the credentials that you get\n from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim\n that presents the highest-precedence group that a user belongs to. Both ID and access\n tokens also contain a cognito:groups claim that list all the groups that a\n user is a member of.
A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher or null Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles and\n cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim isn't\n set in users' tokens.
The default Precedence value is null. The maximum Precedence\n value is 2^31-1.
The response object for a created group.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateIdentityProvider": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateIdentityProviderRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateIdentityProviderResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#DuplicateProviderException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Adds a configuration and trust relationship between a third-party identity provider\n (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through\n managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe Id of the user pool where you want to create an IdP.
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameTypeV2", "traits": { "smithy.api#documentation": "The name that you want to assign to the IdP. You can pass the identity provider name\n in the identity_provider query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated\n IdP.
The type of IdP that you want to add. Amazon Cognito supports OIDC, SAML 2.0, Login With\n Amazon, Sign In With Apple, Google, and Facebook IdPs.
", "smithy.api#required": {} } }, "ProviderDetails": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { "smithy.api#documentation": "The scopes, URLs, and identifiers for your external identity provider. The following\nexamples describe the provider detail keys for each IdP type. These values and their\nschema are subject to change. Social IdP authorize_scopes values must match\nthe values listed here.
Amazon Cognito accepts the following elements when it can't discover endpoint\n URLs from oidc_issuer: attributes_url,\n authorize_url, jwks_uri,\n token_url.
Create or update request: \"ProviderDetails\": {\n \"attributes_request_method\": \"GET\", \"attributes_url\":\n \"https://auth.example.com/userInfo\", \"authorize_scopes\": \"openid profile\n email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n \"client_id\": \"1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"jwks_uri\":\n \"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n \"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n }\n
Describe response: \"ProviderDetails\": { \"attributes_request_method\":\n \"GET\", \"attributes_url\": \"https://auth.example.com/userInfo\",\n \"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"openid\n profile email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n \"client_id\": \"1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"jwks_uri\":\n \"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n \"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n }\n
Create or update request with Metadata URL: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataURL\":\n \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\" }\n
Create or update request with Metadata file: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \n \"MetadataFile\": \"[metadata XML]\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\" }\n
The value of MetadataFile must be the plaintext metadata document with all \n quote (\") characters escaped by backslashes.
Describe response: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"ActiveEncryptionCertificate\": \"[certificate]\",\n \"MetadataURL\": \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\", \"SLORedirectBindingURI\":\n \"https://auth.example.com/slo/saml\", \"SSORedirectBindingURI\":\n \"https://auth.example.com/sso/saml\" }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"profile postal_code\", \"client_id\":\n \"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n \"provider-app-client-secret\"\n
Describe response: \"ProviderDetails\": { \"attributes_url\":\n \"https://api.amazon.com/user/profile\", \"attributes_url_add_attributes\":\n \"false\", \"authorize_scopes\": \"profile postal_code\", \"authorize_url\":\n \"https://www.amazon.com/ap/oa\", \"client_id\":\n \"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"token_request_method\": \"POST\",\n \"token_url\": \"https://api.amazon.com/auth/o2/token\" }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"email profile openid\", \"client_id\":\n \"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n \"provider-app-client-secret\" }\n
Describe response: \"ProviderDetails\": { \"attributes_url\":\n \"https://people.googleapis.com/v1/people/me?personFields=\",\n \"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"email\n profile openid\", \"authorize_url\":\n \"https://accounts.google.com/o/oauth2/v2/auth\", \"client_id\":\n \"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n \"provider-app-client-secret\", \"oidc_issuer\":\n \"https://accounts.google.com\", \"token_request_method\": \"POST\",\n \"token_url\": \"https://www.googleapis.com/oauth2/v4/token\"\n }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"email name\", \"client_id\": \"com.example.cognito\", \"private_key\": \"1EXAMPLE\", \n \"key_id\": \"2EXAMPLE\", \"team_id\": \"3EXAMPLE\" }\n
Describe response: \"ProviderDetails\": {\n \"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"email\n name\", \"authorize_url\": \"https://appleid.apple.com/auth/authorize\",\n \"client_id\": \"com.example.cognito\", \"key_id\": \"1EXAMPLE\", \"oidc_issuer\":\n \"https://appleid.apple.com\", \"team_id\": \"2EXAMPLE\",\n \"token_request_method\": \"POST\", \"token_url\":\n \"https://appleid.apple.com/auth/token\" }\n
Create or update request: \"ProviderDetails\": { \"api_version\": \"v17.0\", \n \"authorize_scopes\": \"public_profile, email\", \"client_id\": \"1example23456789\", \n \"client_secret\": \"provider-app-client-secret\" }\n
Describe response: \"ProviderDetails\": \n { \"api_version\": \"v17.0\", \"attributes_url\": \"https://graph.facebook.com/v17.0/me?fields=\", \n \"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"public_profile, email\", \n \"authorize_url\": \"https://www.facebook.com/v17.0/dialog/oauth\", \"client_id\": \n \"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"token_request_method\": \n \"GET\", \"token_url\": \"https://graph.facebook.com/v17.0/oauth/access_token\" }\n
A mapping of IdP attributes to standard and custom user pool attributes. Specify a\n user pool attribute as the key of the key-value pair, and the IdP attribute claim name\n as the value.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { "smithy.api#documentation": "An array of IdP identifiers, for example \"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\"\n ]. Identifiers are friendly names that you can pass in the\n idp_identifier query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated IdP.\n Identifiers in a domain format also enable the use of email-address matching with SAML providers.
A mapping between the authentication context class reference (ACR) levels of your user\n pool and the ACR values of the external OpenID Connect (OIDC) identity provider (IdP).\n The map is keyed by level, from Level1 through Level4, and each\n value is the ACR value that the IdP uses for the corresponding level. Amazon Cognito uses\n this mapping to translate a requested user pool ACR level to the value that the IdP\n expects, and to map an ACR value that the IdP returns back to a user pool level. When the\n IdP returns an ACR value that isn't mapped, Amazon Cognito resolves it to the lowest\n level. Only OIDC IdPs support ACR mapping.
Setting AcrMapping is available in all feature plans. It isn't restricted\n to the Essentials or Plus feature plan.
The details of the new user pool IdP.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBranding": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates a new set of branding settings for a user pool style and associates it with an\n app client. This operation is the programmatic option for the creation of a new style in\n the branding editor.
\nProvides values for UI customization in a Settings JSON object and image\n files in an Assets array. To send the JSON object Document\n type parameter in Settings, you might need to update to the most recent\n version of your Amazon Web Services SDK. To create a new style with default settings, set\n UseCognitoProvidedValues to true and don't provide\n values for any other options.
This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to create a new branding style.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The app client that you want to create the branding style for. Each style is linked to\n an app client until you delete it.
", "smithy.api#required": {} } }, "UseCognitoProvidedValues": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, applies the default branding style options. These default options are\n managed by Amazon Cognito. You can modify them later in the branding editor.
\nWhen you specify true for this option, you must also omit values for\n Settings and Assets in the request.
A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.
The following components are not currently implemented and reserved for future\n use:
\n\n signUp\n
\n instructions\n
\n sessionTimerDisplay\n
\n languageSelector (for localization, see Managed login localization)\n
An array of image files that you want to apply to functions like backgrounds, logos,\n and icons. Each object must also indicate whether it is for dark mode, light mode, or\n browser-adaptive mode.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CreateManagedLoginBrandingResponse": { "type": "structure", "members": { "ManagedLoginBranding": { "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType", "traits": { "smithy.api#documentation": "The details of the branding style that you created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateResourceServer": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateResourceServerRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateResourceServerResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates a new OAuth2.0 resource server and defines custom scopes within it. Resource\n servers are associated with custom scopes and machine-to-machine (M2M) authorization.\n For more information, see Access control with resource servers.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to create a resource server.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
A friendly name for the resource server.
", "smithy.api#required": {} } }, "Scopes": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType", "traits": { "smithy.api#documentation": "A list of custom scopes. Each scope is a key-value map with the keys\n ScopeName and ScopeDescription. The name of a custom scope\n is a combination of ScopeName and the resource server Name in\n this request, for example MyResourceServerName/MyScopeName.
The details of the new resource server.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateTerms": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateTermsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateTermsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TermsExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates terms documents for the requested app client. When Terms and conditions and\n Privacy policy documents are configured, the app client displays links to them in the\n sign-up page of managed login for the app client.
\nYou can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for\n their current language, with fallback to default if no document exists for\n the language.
Each request accepts one type of terms document and a map of language-to-link for that\n document type. You must provide both types of terms documents in at least one language\n before Amazon Cognito displays your terms documents. Supply each type in separate\n requests.
\nFor more information, see Terms documents.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to create terms documents.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client where you want to create terms documents. Must be an app\n client in the requested user pool.
", "smithy.api#required": {} } }, "TermsName": { "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", "traits": { "smithy.api#documentation": "A friendly name for the document that you want to create in the current request. Must\n begin with terms-of-use or privacy-policy as identification of\n the document type. Provide URLs for both terms-of-use and\n privacy-policy in separate requests.
This parameter is reserved for future use and currently accepts only one value.
", "smithy.api#required": {} } }, "Enforcement": { "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", "traits": { "smithy.api#documentation": "This parameter is reserved for future use and currently accepts only one value.
", "smithy.api#required": {} } }, "Links": { "target": "com.amazonaws.cognitoidentityprovider#LinksType", "traits": { "smithy.api#documentation": "A map of URLs to languages. For each localized language that will view the requested\n TermsName, assign a URL. A selection of cognito:default\n displays for all languages that don't have a language-specific URL.
For example, \"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n \"https://terms.example.com/es\".
A summary of your terms documents. Includes a unique identifier for later changes to\n the terms documents.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserImportJob": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserImportJobRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserImportJobResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PreconditionNotMetException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Creates a user import job. You can import users into user pools from a comma-separated\n values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nA friendly name for the user import job.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that you want to import users into.
", "smithy.api#required": {} } }, "CloudWatchLogsRoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "You must specify an IAM role that has permission to log import-job results to\n Amazon CloudWatch Logs. This parameter is the ARN of that role.
", "smithy.api#required": {} } }, "PasswordHashingAlgorithm": { "target": "com.amazonaws.cognitoidentityprovider#PasswordHashingAlgorithmType", "traits": { "smithy.api#documentation": "The password hashing algorithm used to generate the hashes in the CSV file for this\n import job.
\nValid values: BCRYPT | SCRYPT | ARGON2ID |\n PBKDF2_SHA256\n
Represents the request to create the user import job.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserImportJobResponse": { "type": "structure", "members": { "UserImportJob": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType", "traits": { "smithy.api#documentation": "The details of the user import job. Includes logging destination, status, and the Amazon S3\n pre-signed URL for CSV upload.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to create the user import\n job.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPool": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTaggingException" } ], "traits": { "smithy.api#documentation": "Creates a new Amazon Cognito user pool. This operation sets basic and advanced configuration\n options.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates an app client in a user pool. This operation sets basic and advanced\n configuration options.
\nUnlike app clients created in the console, Amazon Cognito doesn't automatically assign a \nbranding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't \navailable for your client until after you apply a branding style.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to create an app client.
", "smithy.api#required": {} } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { "smithy.api#documentation": "A friendly name for the app client that you want to create.
", "smithy.api#required": {} } }, "GenerateSecret": { "target": "com.amazonaws.cognitoidentityprovider#GenerateSecret", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, generates a client secret for the app client. Client secrets\n are used with server-side and machine-to-machine applications. Client secrets are\n automatically generated; you can't specify a secret value. For more information,\n see App client types.
A custom client secret that you want to use for the app client. You cannot specify both GenerateSecret as true and provide a ClientSecret value.
" } }, "RefreshTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The refresh token time limit. After this limit expires, your user can't use \ntheir refresh token. To specify the time unit for RefreshTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and\nTokenValidityUnits as days, your user can refresh their session\nand retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. \nYou can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the \nvalue with the default value of 30 days. Valid range is displayed below \nin seconds.
If you don't specify otherwise in the configuration of your app client, your refresh\ntokens are valid for 30 days.
" } }, "AccessTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType", "traits": { "smithy.api#documentation": "The access token time limit. After this limit expires, your user can't use \ntheir access token. To specify the time unit for AccessTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and\nTokenValidityUnits to hours, your user can authorize access with\ntheir access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. \nValid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access\ntokens are valid for one hour.
" } }, "IdTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { "smithy.api#documentation": "The ID token time limit. After this limit expires, your user can't use \ntheir ID token. To specify the time unit for IdTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and\nTokenValidityUnits as hours, your user can authenticate their \nsession with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. \nValid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID\ntokens are valid for one hour.
" } }, "TokenValidityUnits": { "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { "smithy.api#documentation": "The units that validity times are represented in. The default unit for refresh tokens\n is days, and the default for ID and access tokens are hours.
" } }, "ReadAttributes": { "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", "traits": { "smithy.api#documentation": "The list of user attributes that you want your app client to have read access to.\n After your user authenticates in your app, their access token authorizes them to read\n their own attribute value for any attribute in this list.
\nWhen you don't specify the ReadAttributes for your app client, your\n app can read the values of email_verified,\n phone_number_verified, and the standard attributes of your user pool.\n When your user pool app client has read access to these default attributes,\n ReadAttributes doesn't return any information. Amazon Cognito only\n populates ReadAttributes in the API response if you have specified your own\n custom set of read attributes.
The list of user attributes that you want your app client to have write access to.\n After your user authenticates in your app, their access token authorizes them to set or\n modify their own attribute value for any attribute in this list.
\nWhen you don't specify the WriteAttributes for your app client, your\n app can write the values of the Standard attributes of your user pool. When your user\n pool has write access to these default attributes, WriteAttributes\n doesn't return any information. Amazon Cognito only populates\n WriteAttributes in the API response if you have specified your own\n custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all\n attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when\n users sign in to your application through an IdP. If your app client does not have write\n access to a mapped attribute, Amazon Cognito throws an error when it tries to update the\n attribute. For more information, see Specifying IdP Attribute Mappings for Your user\n pool.
" } }, "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { "smithy.api#documentation": "The authentication flows that you want your user pool client to support. For each app \nclient in your user pool, you can sign in your users with any combination of one or more flows, including with \na user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that \nyou define with Lambda functions.
\nIf you don't specify a value for ExplicitAuthFlows, your app client supports \nALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.\n
The values for authentication flow options include the following.
\n\n ALLOW_USER_AUTH: Enable selection-based sign-in\n with USER_AUTH. This setting covers username-password,\n secure remote password (SRP), passwordless, and passkey authentication.\n This authentiation flow can do username-password and SRP authentication\n without other ExplicitAuthFlows permitting them. For example\n users can complete an SRP challenge through USER_AUTH \n without the flow USER_SRP_AUTH being active for the app\n client. This flow doesn't include CUSTOM_AUTH.\n
To activate this setting, your user pool must be in the \n Essentials tier or higher.
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces\n the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app\n passes a user name and password to Amazon Cognito in the request, instead of using the Secure \n Remote Password (SRP) protocol to securely transmit the password.
\n ALLOW_CUSTOM_AUTH: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh\n tokens.
\n ALLOW_TOKEN_EXCHANGE_IMPERSONATION \u2013 Use this flow to request\n GetDerivedToken token exchanges without an ActorToken.\n The issued token represents the subject user directly.
\n ALLOW_TOKEN_EXCHANGE_DELEGATION \u2013 Use this flow to request\n GetDerivedToken token exchanges that include an\n ActorToken. The issued token carries an act claim that\n identifies the intermediary acting on the behalf of the subject.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.
A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.
This parameter sets the IdPs that managed \n login will display on the login page for your app client. The removal of \n COGNITO from this list doesn't prevent authentication operations \n for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent \n SDK-based authentication is to block access with a WAF rule.\n
A list of allowed redirect, or callback, URLs for managed login authentication. These\n URLs are the paths where you want to send your users' browsers after they complete\n authentication with managed login or a third-party IdP. Typically, callback URLs are the\n home of an application that uses OAuth or OIDC libraries to process authentication\n outcomes.
\nA redirect URI must meet the following requirements:
\nBe an absolute URI.
\nBe registered with the authorization server. Amazon Cognito doesn't accept\n authorization requests with redirect_uri values that aren't in\n the list of CallbackURLs that you provide in this parameter.
Not include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for callback URLs to\n http://localhost, http://127.0.0.1 and\n http://[::1]. These callback URLs are for testing purposes only. You\n can specify custom TCP ports for your callback URLs.
App callback URLs such as myapp://example are also supported.
A list of allowed logout URLs for managed login authentication. When you pass\n logout_uri and client_id parameters to\n /logout, Amazon Cognito signs out your user and redirects them to the logout\n URL. This parameter describes the URLs that you want to be the permitted targets of\n logout_uri. A typical use of these URLs is when a user selects \"Sign\n out\" and you redirect them to your public homepage. For more information, see Logout\n endpoint.
The default redirect URI. In app clients with one assigned IdP, replaces\n redirect_uri in authentication requests. Must be in the\n CallbackURLs list.
The OAuth grant types that you want your app client to generate for clients in managed\n login authentication. To create an app client that generates client credentials grants,\n you must add client_credentials as the only allowed OAuth flow.
Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.
Issue the access token, and the ID token when scopes like\n openid and profile are requested, directly to\n your user.
Issue the access token from the /oauth2/token endpoint\n directly to a non-person user, authorized by a combination of the client ID\n and client secret.
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app\n client to authorize access with. Scopes govern access control to user pool self-service\n API operations, user data from the userInfo endpoint, and third-party APIs.\n Scope values include phone, email, openid, and\n profile. The aws.cognito.signin.user.admin scope\n authorizes user self-service operations. Custom scopes with resource servers authorize\n access to external APIs.
Set to true to use OAuth 2.0 authorization server features in your app client.
This parameter must have a value of true before you can configure \nthe following features in your app client.
\n CallBackURLs: Callback URLs.
\n LogoutURLs: Sign-out redirect URLs.
\n AllowedOAuthScopes: OAuth 2.0 scopes.
\n AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set \nAllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or \nUpdateUserPoolClient API request. If you don't set a value for \nAllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults \nto false. When false, only SDK-based API sign-in is permitted.
The user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to\n analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For\n more information, see Using Amazon Pinpoint analytics.
" } }, "PreventUserExistenceErrors": { "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", "traits": { "smithy.api#documentation": "When ENABLED, suppresses messages that might indicate a valid user exists \n when someone attempts sign-in. This parameters sets your preference for the errors and \n responses that you want Amazon Cognito APIs to return during authentication, account\n confirmation, and password recovery when the user doesn't exist in the user pool. When\n set to ENABLED and the user doesn't exist, authentication returns an error\n indicating either the username or password was incorrect. Account confirmation and\n password recovery return a response indicating a code was sent to a simulated\n destination. When set to LEGACY, those APIs return a\n UserNotFoundException exception if the user doesn't exist in the user\n pool.
Defaults to LEGACY.
Activates or deactivates token\n revocation in the target app client.
\nIf you don't include this parameter, token revocation is automatically activated for\n the new user pool client.
" } }, "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "When true, your application can include additional\n UserContextData in authentication requests. This data includes the IP\n address, and contributes to analysis by threat protection features. For more information\n about propagation of user context data, see Adding session data to API requests. If you don\u2019t include this parameter,\n you can't send the source IP address to Amazon Cognito threat protection features. You can only\n activate EnablePropagateAdditionalUserContextData in an app client that has\n a client secret.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.
" } }, "PublishSecretsInAWSSecretsManager": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "Specifies whether Amazon Cognito stores and manages this app client's secret in\n Amazon Web Services\n Secrets Manager instead of returning the plaintext value. Applies only when\n GenerateSecret is true. When you set this parameter to\n true, the response returns ClientSecretArn instead of\n ClientSecret. Amazon Cognito starts the first rotation of the secret right away,\n and then rotates the secret every 7 days by default. You can change the rotation\n schedule in Secrets Manager.
Defaults to false. If you don't set this parameter, Amazon Cognito doesn't\n manage the secret in Secrets Manager and returns the plaintext ClientSecret\n value. The Amazon Cognito console turns on this option by default when it creates an app client\n with a generated client secret.
Represents the request to create a user pool client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolClientResponse": { "type": "structure", "members": { "UserPoolClient": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientType", "traits": { "smithy.api#documentation": "The details of the new app client.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to create a user pool client.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomain": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "A user pool domain hosts managed login, an authorization server and web server for\n authentication in your application. This operation creates a new user pool prefix domain\n or custom domain and sets the managed login branding version. Set the branding version\n to 1 for hosted UI (classic) or 2 for managed login. When you\n choose a custom domain, you must provide an SSL certificate in the US East (N. Virginia)\n Amazon Web Services Region in your request.
Your prefix domain might take up to one minute to take effect. Your custom domain is\n online within five minutes, but it can take up to one hour to distribute your SSL\n certificate.
\nFor more information about adding a custom domain to your user pool, see Configuring a user pool domain.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com. For prefix domains, this is the prefix alone, such as\n myprefix. A prefix value of myprefix for a user pool in\n the us-east-1 Region results in a domain of\n myprefix.auth.us-east-1.amazoncognito.com.
The ID of the user pool where you want to add a domain.
", "smithy.api#required": {} } }, "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { "smithy.api#documentation": "The version of managed login branding that you want to apply to your domain. A value\n of 1 indicates hosted UI (classic) and a version of 2\n indicates managed login.
Managed login requires that your user pool be configured for any feature plan other than Lite.
A ManagedLoginVersion value of 2 does not activate managed\n login pages for your app client. When you create an app client programmatically,\n your app client has no branding style. To use managed login, create a branding style\n using the CreateManagedLoginBranding operation. When you use the console, Amazon Cognito assigns\n a default branding style automatically. When you use the API or an SDK, you must create a\n branding style yourself.
The configuration for a custom domain. Configures your domain with an Certificate Manager\n certificate in the us-east-1 Region.
Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can\n omit this parameter and use a prefix domain instead.
\nWhen you create a custom domain, the passkey RP ID defaults to the custom domain. If\n you had a prefix domain active, this will cause passkey integration for your prefix\n domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey\n integration working, you can explicitly set RP ID to the prefix domain.
" } }, "Routing": { "target": "com.amazonaws.cognitoidentityprovider#RoutingType", "traits": { "smithy.api#documentation": "The configuration of routing for requests to the domain for replicas of a replicated user pool.\n The routing configuration is currently only supported for custom domains.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolDomainResponse": { "type": "structure", "members": { "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { "smithy.api#documentation": "The version of managed login branding applied your domain. A value of 1\n indicates hosted UI (classic) and a version of 2 indicates managed\n login.
The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your\n managed login or classic hosted UI pages. Your domain-name authority must have an alias\n record that points requests for your custom domain to this FQDN. Amazon Cognito returns this\n value if you set a custom domain with CustomDomainConfig. If you set an\n Amazon Cognito prefix domain, this parameter returns null.
The routing configuration that was applied to the user pool domain.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolReplica": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolReplicaRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#CreateUserPoolReplicaResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTaggingException" } ], "traits": { "smithy.api#documentation": "Creates a replica of an existing user pool in a specified Amazon Web Services Region. The replica\n enables multi-region replication for high availability and disaster recovery. To create\n a replica, you must have permissions to create user pools in the target Region.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool to replicate.
", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.cognitoidentityprovider#RegionNameType", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where you want to create the replica user pool.
", "smithy.api#required": {} } }, "UserPoolTags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { "smithy.api#documentation": "A map of tags to assign to the replica user pool. Each tag consists of a key and an\n optional value, both of which you define. You can maintain tags independently on replica\n user pools.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolReplicaResponse": { "type": "structure", "members": { "UserPoolReplica": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolReplicaType", "traits": { "smithy.api#documentation": "Information about the created user pool replica, including its status and role.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolRequest": { "type": "structure", "members": { "PoolName": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", "traits": { "smithy.api#documentation": "A friendly name for your user pool.
", "smithy.api#required": {} } }, "Policies": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { "smithy.api#documentation": "The password policy and sign-in policy in the user pool. The password policy sets\n options like password complexity requirements and password history. The sign-in policy\n sets the options available to applications in choice-based authentication.
" } }, "DeletionProtection": { "target": "com.amazonaws.cognitoidentityprovider#DeletionProtectionType", "traits": { "smithy.api#documentation": "When active, DeletionProtection prevents accidental deletion of your user\npool. Before you can delete a user pool that you have protected against deletion, you\nmust deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, \nAmazon Cognito returns an InvalidParameterException error. To delete a protected user pool, \nsend a new DeleteUserPool request after you deactivate deletion protection in an \nUpdateUserPool API request.
A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of authentication operations. Triggers can modify the outcome of the operations\n that invoked them.
" } }, "AutoVerifiedAttributes": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { "smithy.api#documentation": "The attributes that you want your user pool to automatically verify. For more\n information, see Verifying contact information at sign-up.
" } }, "AliasAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", "traits": { "smithy.api#documentation": "Attributes supported as an alias for this user pool. For more information about alias\n attributes, see Customizing sign-in attributes.
" } }, "UsernameAttributes": { "target": "com.amazonaws.cognitoidentityprovider#UsernameAttributesListType", "traits": { "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when\n they sign up. For more information, see Customizing sign-in attributes.
" } }, "SmsVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "VerificationMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { "smithy.api#documentation": "The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.
\nSet the email message type that corresponds to your DefaultEmailOption\n selection. For CONFIRM_WITH_LINK, specify an\n EmailMessageByLink and leave EmailMessage blank. For\n CONFIRM_WITH_CODE, specify an EmailMessage and leave\n EmailMessageByLink blank. When you supply both parameters with either\n choice, Amazon Cognito returns an error.
The contents of the SMS message that your user pool sends to users in SMS OTP and MFA\n authentication.
" } }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { "smithy.api#documentation": "Sets multi-factor authentication (MFA) to be on, off, or optional. When\n ON, all users must set up MFA before they can sign in. When\n OPTIONAL, your application must make a client-side determination of\n whether a user wants to register an MFA device. For user pools with adaptive\n authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login\n doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in\n API responses and in managed login for users who have chosen and configured a preferred\n MFA factor.
The CreateUserPool operation supports only SMS MFA configuration. If you\n set MfaConfiguration to either of these values, include an\n SmsConfiguration in the same request:
\n ON \u2013 Requires MFA for all users
\n OPTIONAL \u2013 Makes MFA optional for each user
If you omit SmsConfiguration, the operation returns an\n InvalidParameterException. To configure TOTP or email MFA, use the SetUserPoolMfaConfig operation. You can also use\n SetUserPoolMfaConfig to add MFA factors later.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to email addresses and phone numbers.
The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that\n you have deactivated device remembering in your user pool.
\nWhen you provide a value for any DeviceConfiguration field, you\n activate the Amazon Cognito device-remembering feature. For more information, see Working with devices.
The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.
" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { "smithy.api#documentation": "The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account. For more information see\n SMS message settings.
" } }, "UserPoolTags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { "smithy.api#documentation": "The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.
" } }, "AdminCreateUserConfig": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", "traits": { "smithy.api#documentation": "The configuration for administrative creation of users. Includes the template for the\n invitation message for new users, the duration of temporary passwords, and permitting\n self-service sign-up.
" } }, "Schema": { "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributesListType", "traits": { "smithy.api#documentation": "An array of attributes for the new user pool. You can add custom attributes and modify\n the properties of default attributes. The specifications in this parameter set the\n required attributes in your user pool. For more information, see Working with user attributes.
" } }, "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { "smithy.api#documentation": "Contains settings for activation of threat protection, including the operating \nmode and additional authentication types. To log user security information but take \nno action, set to AUDIT. To configure automatic security responses to \npotentially unwanted traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the \n Plus tier.
" } }, "DcrConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DcrConfigurationType", "traits": { "smithy.api#documentation": "The dynamic client registration configuration for the user pool. With dynamic client\n registration, applications can register their own app clients at runtime through the\n registration endpoint of your user pool domain. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "UsernameConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { "smithy.api#documentation": "Sets the case sensitivity option for sign-in usernames. When\n CaseSensitive is false (case insensitive), users can sign\n in with any combination of capital and lowercase letters. For example,\n username, USERNAME, or UserName, or for\n email, email@example.com or EMaiL@eXamplE.Com. For most use\n cases, set case sensitivity to false as a best practice. When usernames and\n email addresses are case insensitive, Amazon Cognito treats any variation in case as the same\n user, and prevents a case variation from being assigned to the same attribute for a\n different user.
When CaseSensitive is true (case sensitive), Amazon Cognito\n interprets USERNAME and UserName as distinct users.
This configuration is immutable after you set it.
" } }, "AccountRecoverySetting": { "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", "traits": { "smithy.api#documentation": "The available verified method a user can use to recover their password when they call\n ForgotPassword. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. Email MFA is also disqualifying for account recovery\n with email. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine\n the recovery method where SMS is preferred over email.
As a best practice, configure both verified_email and\n verified_phone_number, with one having a higher priority than the\n other.
The user pool feature plan, or tier. This parameter determines the\n eligibility of the user pool for features like managed login, access-token\n customization, and threat protection. Defaults to ESSENTIALS.
The key configuration for the user pool. Specifies the key type and KMS key ARN for\n encryption.
" } }, "IssuerConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#IssuerConfigurationType", "traits": { "smithy.api#documentation": "The issuer configuration for the user pool. Specifies the issuer type for token\n generation.
" } }, "AcrConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AcrConfigurationType", "traits": { "smithy.api#documentation": "The custom names for the authentication context class reference\n (ACR) levels in your user pool. Amazon Cognito defines four fixed ACR levels that\n represent increasing authentication assurance. The combination of authentication factors\n that satisfies each level is fixed and you can't change it. With this configuration, you\n customize only the URI name that Amazon Cognito reports for each level in the\n acr token claim.
You can override a subset of the levels. By default, the levels are named\n urn:cognito:loa:1 through urn:cognito:loa:4, and Amazon Cognito\n applies the default name to any level that you don't specify. Each name must be\n unique across all four levels, including any default names that apply to levels you\n don't override. A name can contain any character\n that is valid in a URL or a URN.
Configuring custom ACR level names requires the Essentials or Plus feature plan.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } } }, "traits": { "smithy.api#documentation": "Represents the request to create a user pool.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#CreateUserPoolResponse": { "type": "structure", "members": { "UserPool": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolType", "traits": { "smithy.api#documentation": "The details of the created user pool.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server for the request to create a user pool.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#CustomAttributeNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" } }, "com.amazonaws.cognitoidentityprovider#CustomAttributesListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#SchemaAttributeType" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType": { "type": "structure", "members": { "CertificateArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use\n this certificate for the subdomain of your custom domain.
", "smithy.api#required": {} } }, "SecurityPolicy": { "target": "com.amazonaws.cognitoidentityprovider#SecurityPolicyType", "traits": { "smithy.api#documentation": "The security policy for the custom domain. Defines the minimum TLS version and cipher\n suites that Amazon CloudFront supports when communicating with clients. For specific guidance,\n see Supported protocols and ciphers between viewers and CloudFront. Valid values are\n as follows:
\n\n TLS_V1_3_2025 (strictest): A post-quantum-ready policy requiring TLS 1.3.\n It provides the strongest security posture and is ideal for\n workloads where all clients and browsers are updated to the latest\n versions. Supported protocols and ciphers for TLSv1.3_2025.
\n TLS_V1_2_2021 (recommended): A post-quantum-ready policy which prefers TLS 1.3 but allows\n fallback to TLS 1.2 to accommodate older clients. It\n is the recommended minimum for typical commercial-grade consumer\n applications. Supported protocols and ciphers for TLSv1.2_2021.
\n TLS_V1 (strongly discouraged): Permits fallback to TLS 1.0. It offers the broadest\n compatibility, including support for legacy clients that are more than a\n decade old. This compatibility comes at the expense of allowing TLS versions\n and cryptographic algorithms that are no longer considered safe for\n commercial use. Supported protocols and ciphers for TLSv1.
The configuration for a custom domain, including the SSL certificate and TLS security\n policy.
" } }, "com.amazonaws.cognitoidentityprovider#CustomEmailLambdaVersionConfigType": { "type": "structure", "members": { "LambdaVersion": { "target": "com.amazonaws.cognitoidentityprovider#CustomEmailSenderLambdaVersionType", "traits": { "smithy.api#documentation": "The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
\nYou must use a LambdaVersion of V1_0 with a custom sender\n function.
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The properties of a custom email sender Lambda trigger.
" } }, "com.amazonaws.cognitoidentityprovider#CustomEmailSenderLambdaVersionType": { "type": "enum", "members": { "V1_0": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V1_0" } } } }, "com.amazonaws.cognitoidentityprovider#CustomSMSLambdaVersionConfigType": { "type": "structure", "members": { "LambdaVersion": { "target": "com.amazonaws.cognitoidentityprovider#CustomSMSSenderLambdaVersionType", "traits": { "smithy.api#documentation": "The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
\nYou must use a LambdaVersion of V1_0 with a custom sender\n function.
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The properties of a custom SMS sender Lambda trigger.
" } }, "com.amazonaws.cognitoidentityprovider#CustomSMSSenderLambdaVersionType": { "type": "enum", "members": { "V1_0": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V1_0" } } } }, "com.amazonaws.cognitoidentityprovider#DateType": { "type": "timestamp" }, "com.amazonaws.cognitoidentityprovider#DcrConfigurationType": { "type": "structure", "members": { "EnableStatus": { "target": "com.amazonaws.cognitoidentityprovider#StatusType", "traits": { "smithy.api#documentation": "Specifies whether dynamic client registration is turned on for the user pool. If you\n provide a dynamic client registration configuration without this value, Amazon Cognito turns\n dynamic client registration on.
" } }, "OpenDcrEnabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether open registration is turned on. When open registration is on,\n applications can register app clients without an initial access token. The default value\n is false.
The OAuth grant types that an app client created through authenticated registration can\n request. If you don't set this value, authenticated registration permits the\n code and client_credentials grant types. If you set an\n empty list, Amazon Cognito rejects authenticated registration requests. Dynamic client\n registration supports the following values. Amazon Cognito accepts implicit in this\n list but ignores it.
Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.
Issue the access token from the /oauth2/token endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The OAuth grant types that an app client created through open registration can request.\n If you don't set this value, open registration permits only the code\n grant type. If you set an empty list, Amazon Cognito rejects open registration requests. If you add\n client_credentials, anyone can register an app client that requests\n machine-to-machine (M2M) access tokens, and you pay for the M2M token requests that those\n app clients make. Dynamic client registration supports the following values. Amazon Cognito\n accepts implicit in this list but ignores it.
Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.
Issue the access token from the /oauth2/token endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The scopes that an app client created through dynamic client registration can request,\n in addition to the standard OpenID Connect (OIDC) scopes. You can include custom scopes\n from your resource servers and aws.cognito.signin.user.admin. Registered app\n clients can request the OIDC scopes openid, email,\n phone, and profile without listing them here. If you\n don't set this value, registered app clients can request only the OIDC scopes. A\n registered app client can't request the aws.cognito/dcr/register scope,\n even if you include it in this list.
The dynamic client registration configuration for a user pool. Dynamic client\n registration lets applications register their own app clients at runtime through the\n registration endpoint of your user pool domain. To activate this setting, your user pool must be in the \n Essentials tier or higher.
\nApplications register app clients at the /oauth2/register endpoint of your\n user pool domain. In authenticated registration, the application sends an access token\n from your user pool that has the aws.cognito/dcr/register scope. In open\n registration, the application doesn't send a token.
When you include this configuration in an UpdateUserPool request, Amazon Cognito\n replaces the existing configuration with the one that you provide.
Deletes a Client ID Metadata Document (CIMD) policy.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the CIMD policy.
", "smithy.api#required": {} } }, "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteCIMDPolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteGroup": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteGroupRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a group from the specified user pool. When you delete a group, that group no\n longer contributes to users' cognito:preferred_group or\n cognito:groups claims, and no longer influence access-control decision\n that are based on group membership. For more information about user pool groups, see\n Adding groups to a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the group that you want to delete.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to delete the group.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteIdentityProvider": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteIdentityProviderRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnsupportedIdentityProviderException" } ], "traits": { "smithy.api#documentation": "Deletes a user pool identity provider (IdP). After you delete an IdP, users can no\n longer sign in to your user pool through that IdP. For more information about user pool\n IdPs, see Third-party IdP sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to delete the identity provider.
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { "smithy.api#documentation": "The name of the IdP that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBranding": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteManagedLoginBrandingRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a managed login branding style. When you delete a style, you delete the\n branding association for an app client. When an app client doesn't have a style\n assigned, your managed login pages for that app client are nonfunctional until you\n create a new style or switch the domain branding version.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the managed login branding style that you want to delete.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the managed login branding style that you want\n to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteResourceServer": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteResourceServerRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a resource server. After you delete a resource server, users can no longer\n generate access tokens with scopes that are associate with that resource server.
\nResource servers are associated with custom scopes and machine-to-machine (M2M)\n authorization. For more information, see Access control with resource servers.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to delete the resource server.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { "smithy.api#documentation": "The identifier of the resource server that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteTerms": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteTermsRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes the terms documents with the requested ID from your app client.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the terms documents that you want to delete.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the terms documents that you want to\n delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Deletes the profile of the currently signed-in user. A deleted user profile can no\n longer be used to sign in and can't be restored.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nDeletes attributes from the currently signed-in user. For example, your application\n can submit a request to this operation when a user wants to remove their\n birthdate attribute value.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nAn array of strings representing the user attribute names you want to delete.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name, for example custom:department.
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
Represents the request to delete user attributes.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserAttributesResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server to delete user attributes.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPool": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserImportInProgressException" } ], "traits": { "smithy.api#documentation": "Deletes a user pool. After you delete a user pool, users can no longer sign in to any\n associated applications.
\nWhen you delete a user pool, it's no longer visible or operational in your Amazon Web Services account. Amazon Cognito retains deleted user pools in an inactive state for 14\n days, then begins a cleanup process that fully removes them from Amazon Web Services systems. In case\n of accidental deletion, contact Amazon Web Services Support within 14 days for restoration\n assistance.
\nAmazon Cognito begins full deletion of all resources from deleted user pools after 14 days. In\n the case of large user pools, the cleanup process might take significant additional time\n before all user data is permanently deleted.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClient": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a user pool app client. After you delete an app client, users can no longer\n sign in to the associated application.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to delete the client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the user pool app client that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to delete a user pool client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientSecret": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientSecretRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientSecretResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalServerException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a specific client secret from a user pool app client. You cannot delete the last remaining secret for an app client.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientSecretRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the app client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client from which you want to delete the secret.
", "smithy.api#required": {} } }, "ClientSecretId": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretIdType", "traits": { "smithy.api#documentation": "The unique identifier of the client secret you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request to delete a specific client secret from a user pool app client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolClientSecretResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response from deleting a client secret.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomain": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomainRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomainResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID and domain identifier, deletes a user pool domain. After you\n delete a user pool domain, your managed login pages and authorization server are no\n longer available.
" } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomainRequest": { "type": "structure", "members": { "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { "smithy.api#documentation": "The domain that you want to delete. For custom domains, this is the fully-qualified\n domain name like auth.example.com. For Amazon Cognito prefix domains, this is the\n prefix alone, like myprefix.
The ID of the user pool where you want to delete the domain.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolDomainResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolReplica": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolReplicaRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DeleteUserPoolReplicaResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a secondary replica user pool. You can only delete replicas that are in the\n INACTIVE status. This operation must be called from the primary Region.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the replica to delete.
", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.cognitoidentityprovider#RegionNameType", "traits": { "smithy.api#documentation": "The Amazon Web Services Region of the replica to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolReplicaResponse": { "type": "structure", "members": { "UserPoolReplica": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolReplicaType", "traits": { "smithy.api#documentation": "Information about the deleted user pool replica.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserPoolRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to delete a user pool.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteUserRequest": { "type": "structure", "members": { "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
Represents the request to delete a user.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredential": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Deletes a registered passkey, or WebAuthn, authenticator for the currently signed-in\n user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The unique identifier of the passkey that you want to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DeleteWebAuthnCredentialResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DeletionProtectionType": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } } } }, "com.amazonaws.cognitoidentityprovider#DeliveryMediumListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType" } }, "com.amazonaws.cognitoidentityprovider#DeliveryMediumType": { "type": "enum", "members": { "SMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMS" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } } } }, "com.amazonaws.cognitoidentityprovider#DescribeCIMDPolicy": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeCIMDPolicyRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeCIMDPolicyResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns the configuration of a Client ID Metadata Document (CIMD) policy.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the CIMD policy.
", "smithy.api#required": {} } }, "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy that you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeCIMDPolicyResponse": { "type": "structure", "members": { "CIMDPolicy": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyType", "traits": { "smithy.api#documentation": "The configuration of the requested CIMD policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeIdentityProvider": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeIdentityProviderRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeIdentityProviderResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID and identity provider (IdP) name, returns details about the\n IdP.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeIdentityProviderRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that has the IdP that you want to describe..
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { "smithy.api#documentation": "The name of the IdP that you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeIdentityProviderResponse": { "type": "structure", "members": { "IdentityProvider": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderType", "traits": { "smithy.api#documentation": "The details of the requested IdP.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBranding": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given the ID of a managed login branding style, returns detailed information about the\n style.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClient": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given the ID of a user pool app client, returns detailed information about the style\n assigned to the app client.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingByClientRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the app client where you want more information\n about the managed login branding style.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The app client that's assigned to the branding style that you want more information\n about.
", "smithy.api#required": {} } }, "ReturnMergedResources": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, returns values for branding options that are unchanged from\n Amazon Cognito defaults. When false or when you omit this parameter, returns only\n values that you customized in your branding style.
The details of the requested branding style.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeManagedLoginBrandingRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the managed login branding style that you want\n to get information about.
", "smithy.api#required": {} } }, "ManagedLoginBrandingId": { "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", "traits": { "smithy.api#documentation": "The ID of the managed login branding style that you want to get more information\n about.
", "smithy.api#required": {} } }, "ReturnMergedResources": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, returns values for branding options that are unchanged from\n Amazon Cognito defaults. When false or when you omit this parameter, returns only\n values that you customized in your branding style.
The details of the requested branding style.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribePointInTimeRecovery": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribePointInTimeRecoveryRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribePointInTimeRecoveryResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns details about a point-in-time recovery of a user pool, including its status\n and the point in time that it restores the user pool to. After Amazon Cognito generates the\n recovery preview, the response also includes the number of entities that the recovery\n creates, updates, and deletes. Review the preview before you apply the recovery with a\n request or discard it with a request.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the recovery that you want to describe.
", "smithy.api#required": {} } }, "RestoreId": { "target": "com.amazonaws.cognitoidentityprovider#RestoreIdType", "traits": { "smithy.api#documentation": "The ID of the recovery that you want to describe. Amazon Cognito returns this ID in the\n response to an InitiatePointInTimeRecovery request.
The details of the requested recovery, including its status, the point in time that\n it restores the user pool to, and the recovery preview.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeResourceServer": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeResourceServerRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeResourceServerResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Describes a resource server. For more information about resource servers, see Access control with resource servers.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeResourceServerRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that hosts the resource server.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The details of the requested resource server.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeRiskConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeRiskConfigurationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeRiskConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnNotEnabledException" } ], "traits": { "smithy.api#documentation": "Given an app client or user pool ID where threat protection is configured, describes\n the risk configuration. This operation returns details about adaptive authentication,\n compromised credentials, and IP-address allow- and denylists. For more information about\n threat protection, see Threat protection.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeRiskConfigurationRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool with the risk configuration that you want to inspect. You can\n apply default risk configuration at the user pool level and further customize it from\n user pool defaults at the app-client level. Specify ClientId to inspect\n client-level configuration, or UserPoolId to inspect pool-level\n configuration.
The ID of the app client with the risk configuration that you want to inspect. You can\n apply default risk configuration at the user pool level and further customize it from\n user pool defaults at the app-client level. Specify ClientId to inspect\n client-level configuration, or UserPoolId to inspect pool-level\n configuration.
The details of the requested risk configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeTerms": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeTermsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeTermsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns details for the requested terms documents ID. For more information, see Terms documents.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nReturns details for the terms documents that are associated with an app client,\n identified by the app client ID, user pool ID, and terms name. For\n more information, see Terms documents.
\nTo call DescribeTermsByClient, you must have the\n cognito-idp:DescribeTermsByClient Identity and Access Management (IAM) permission. An IAM\n policy that denies cognito-idp:DescribeTerms also denies requests to\n DescribeTermsByClient.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the app client that the terms documents are associated with.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the terms documents that you want to\n describe.
", "smithy.api#required": {} } }, "TermsName": { "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", "traits": { "smithy.api#documentation": "The name of the terms documents that you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeTermsByClientResponse": { "type": "structure", "members": { "Terms": { "target": "com.amazonaws.cognitoidentityprovider#TermsType", "traits": { "smithy.api#documentation": "A summary of the requested terms documents, including a unique identifier for later\n changes to the terms documents.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeTermsRequest": { "type": "structure", "members": { "TermsId": { "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", "traits": { "smithy.api#documentation": "The ID of the terms documents that you want to describe.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the terms documents that you want to\n describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeTermsResponse": { "type": "structure", "members": { "Terms": { "target": "com.amazonaws.cognitoidentityprovider#TermsType", "traits": { "smithy.api#documentation": "A summary of the requested terms documents. Includes a unique identifier for later\n changes to the terms documents.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserImportJob": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserImportJobRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserImportJobResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.
" } }, "com.amazonaws.cognitoidentityprovider#DescribeUserImportJobRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that's associated with the import job.
", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { "smithy.api#documentation": "The Id of the user import job that you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to describe the user import job.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserImportJobResponse": { "type": "structure", "members": { "UserImportJob": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType", "traits": { "smithy.api#documentation": "The details of the user import job. Includes logging destination, status, and the Amazon S3\n pre-signed URL for CSV upload.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to describe the user import\n job.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPool": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPoolRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPoolResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTaggingException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns configuration information. This operation is useful when\n you want to inspect an existing user pool and programmatically replicate the\n configuration to another user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven an app client ID, returns configuration information. This operation is useful\n when you want to inspect an existing app client and programmatically replicate the\n configuration to another app client. For more information about app clients, see App clients.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the app client you want to describe.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to describe a user pool client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolClientResponse": { "type": "structure", "members": { "UserPoolClient": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientType", "traits": { "smithy.api#documentation": "The details of the request app client.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server from a request to describe the user pool\n client.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolDomain": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPoolDomainRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#DescribeUserPoolDomainResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Given a user pool domain name, returns information about the domain\n configuration.
\nThis operation doesn't return results when you query a prefix domain in a\n secondary Region. Prefix domains are Region-specific and can only be described in\n the Region where they were created. To describe a prefix domain for a replica user\n pool, make the request to the primary Region's endpoint.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe domain that you want to describe. For custom domains, this is the fully-qualified\n domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is\n the prefix alone, such as auth.
The details of the requested user pool domain.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool you want to describe.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to describe the user pool.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#DescribeUserPoolResponse": { "type": "structure", "members": { "UserPool": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolType", "traits": { "smithy.api#documentation": "The details of the requested user pool.
" } } }, "traits": { "smithy.api#documentation": "Represents the response to describe the user pool.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#DescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.cognitoidentityprovider#DeviceConfigurationType": { "type": "structure", "members": { "ChallengeRequiredOnNewDevice": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, a remembered device can sign in with device authentication instead of SMS\n and time-based one-time password (TOTP) factors for multi-factor authentication\n (MFA).
\nWhether or not ChallengeRequiredOnNewDevice is true, users who sign\n in with devices that have not been confirmed or remembered must still provide a\n second factor in a user pool that requires MFA.
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a\n ConfirmDevice API request. In your app, create a prompt for your user\n to choose whether they want to remember their device. Return the user's choice in an\n UpdateDeviceStatus API request.
When DeviceOnlyRememberedOnUserPrompt is false, Amazon\n Cognito immediately remembers devices that you register in a ConfirmDevice\n API request.
The device-remembering configuration for a user pool.
\nWhen you provide a value for any property of DeviceConfiguration, you\n activate the device remembering for the user pool.
This exception is thrown when a user attempts to confirm a device with a device key\n that already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#DeviceKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 55 }, "smithy.api#pattern": "^[\\w-]+_[0-9a-f-]+$" } }, "com.amazonaws.cognitoidentityprovider#DeviceListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#DeviceType" } }, "com.amazonaws.cognitoidentityprovider#DeviceNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.cognitoidentityprovider#DeviceRememberedStatusType": { "type": "enum", "members": { "REMEMBERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "remembered" } }, "NOT_REMEMBERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "not_remembered" } } } }, "com.amazonaws.cognitoidentityprovider#DeviceSecretVerifierConfigType": { "type": "structure", "members": { "PasswordVerifier": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "A password verifier for a user's device. Used in SRP authentication.
" } }, "Salt": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The salt that you want to use in SRP authentication with the user's device.
" } } }, "traits": { "smithy.api#documentation": "A Secure Remote Password (SRP) value that your application generates when you register\n a user's device. For more information, see Getting a device key.
" } }, "com.amazonaws.cognitoidentityprovider#DeviceType": { "type": "structure", "members": { "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { "smithy.api#documentation": "The device key, for example\n us-west-2_EXAMPLE-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Metadata about a user's device, like name and last-access source IP.
" } }, "DeviceCreateDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date when the user last signed in with the device.
" } } }, "traits": { "smithy.api#documentation": "Information about a user's device that they've registered for device SRP\n authentication in your application. For more information, see Working with user devices in your user pool.
" } }, "com.amazonaws.cognitoidentityprovider#Document": { "type": "document" }, "com.amazonaws.cognitoidentityprovider#DomainDescriptionType": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that the domain is attached to.
" } }, "AWSAccountId": { "target": "com.amazonaws.cognitoidentityprovider#AWSAccountIdType", "traits": { "smithy.api#documentation": "The Amazon Web Services account that you created the user pool in.
" } }, "Domain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { "smithy.api#documentation": "The domain string. For custom domains, this is the fully-qualified domain name, such\n as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone,\n such as auth.
The Amazon S3 bucket where the static files for this domain are stored.
" } }, "CloudFrontDistribution": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The Amazon CloudFront endpoint that hosts your custom domain.
" } }, "Version": { "target": "com.amazonaws.cognitoidentityprovider#DomainVersionType", "traits": { "smithy.api#documentation": "The app version.
" } }, "Status": { "target": "com.amazonaws.cognitoidentityprovider#DomainStatusType", "traits": { "smithy.api#documentation": "The domain status.
" } }, "CustomDomainConfig": { "target": "com.amazonaws.cognitoidentityprovider#CustomDomainConfigType", "traits": { "smithy.api#documentation": "The configuration for a custom domain that hosts the sign-up and sign-in webpages for\n your application.
" } }, "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { "smithy.api#documentation": "The version of managed login branding that you want to apply to your domain. A value\n of 1 indicates hosted UI (classic) branding and a version of 2\n indicates managed login branding.
Managed login requires that your user pool be configured for any feature plan other than Lite.
The routing configuration for the domain, including failover settings for multi-region deployments.\n Currently only Failover configurations are allowed.
A container for information about the user pool domain associated with the hosted UI\n and OAuth endpoints.
" } }, "com.amazonaws.cognitoidentityprovider#DomainStatusType": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.cognitoidentityprovider#DomainType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$" } }, "com.amazonaws.cognitoidentityprovider#DomainVersionType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.cognitoidentityprovider#DuplicateProviderException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the provider is already supported by the user\n pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#EmailAddressType": { "type": "string", "traits": { "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" } }, "com.amazonaws.cognitoidentityprovider#EmailConfigurationType": { "type": "structure", "members": { "SourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The ARN of a verified email address or an address from a verified domain in Amazon SES. You\n can set a SourceArn email from a verified domain only with an API request.\n You can set a verified email address, but not an address in a verified domain, in the\n Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following\n ways, depending on the value that you specify for the EmailSendingAccount\n parameter:
If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the\n custom FROM address when it emails your users using its built-in email\n account.
If you specify DEVELOPER, Amazon Cognito emails your users with this\n address by calling Amazon SES on your behalf.
The Region value of the SourceArn parameter must indicate a supported\n Amazon Web Services Region of your user pool. Typically, the Region in the SourceArn and\n the user pool Region are the same. For more information, see Amazon SES email configuration regions in the Amazon Cognito Developer\n Guide.
The destination to which the receiver of the email should reply.
" } }, "EmailSendingAccount": { "target": "com.amazonaws.cognitoidentityprovider#EmailSendingAccountType", "traits": { "smithy.api#documentation": "Specifies whether Amazon Cognito uses its built-in functionality to send your users email\n messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following\n values:
\nWhen Amazon Cognito emails your users, it uses its built-in email functionality.\n When you use the default option, Amazon Cognito allows only a limited number of\n emails each day for your user pool. For typical production environments, the\n default email limit is less than the required delivery volume. To achieve a\n higher delivery volume, specify DEVELOPER to use your Amazon SES email\n configuration.
\nTo look up the email delivery limit for the default option, see Limits in the Amazon Cognito Developer\n Guide.
\nThe default FROM address is no-reply@verificationemail.com.\n To customize the FROM address, provide the Amazon Resource Name (ARN) of an\n Amazon SES verified email address for the SourceArn\n parameter.
When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito\n calls Amazon SES on your behalf to send email from your verified email address.\n When you use this option, the email delivery limits are the same limits that\n apply to your Amazon SES verified email address in your Amazon Web Services account.
\nIf you use this option, provide the ARN of an Amazon SES verified email address\n for the SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional permissions to\n call Amazon SES on your behalf. When you update your user pool with this option,\n Amazon Cognito creates a service-linked role, which is a type of\n role in your Amazon Web Services account. This role contains the permissions\n that allow you to access Amazon SES and send email messages from your email\n address. For more information about the service-linked role that Amazon Cognito\n creates, see Using Service-Linked Roles for Amazon Cognito in the\n Amazon Cognito Developer Guide.
\nEither the sender\u2019s email address or the sender\u2019s name with their email address. For\n example, testuser@example.com or Test User\n . This address appears before the body of the\n email.
The set of configuration rules that can be applied to emails sent using Amazon Simple Email Service. A\n configuration set is applied to an email by including a reference to the configuration\n set in the headers of the email. Once applied, all of the rules in that configuration\n set are applied to the email. Configuration sets can be used to apply the following\n types of rules to emails:
\nAmazon Simple Email Service can track the number of send, delivery, open, click, bounce, and\n complaint events for each email sent. Use event publishing to send\n information about these events to other Amazon Web Services services such as and\n Amazon CloudWatch
\nWhen leasing dedicated IP addresses with Amazon Simple Email Service, you can create groups\n of IP addresses, called dedicated IP pools. You can then associate the\n dedicated IP pools with configuration sets.
\nThe email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.
\nAmazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where\n you created your user pool, and in alternate Regions in some cases. For more\n information on the supported Regions, see Email settings for Amazon Cognito user pools.
\nThe template for the email messages that your user pool sends to users with codes for\n MFA and sign-in with email OTPs. The message must contain the {####}\n placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you\n don't provide this parameter, Amazon Cognito sends messages in the default format.
The subject of the email messages that your user pool sends to users with codes for\n MFA and email OTP sign-in.
" } } }, "traits": { "smithy.api#documentation": "Sets or shows configuration for user pool email message MFA and sign-in with one-time\n passwords (OTPs). Includes the subject and body of the email message template for\n sign-in and MFA messages. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "com.amazonaws.cognitoidentityprovider#EmailMfaMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 20000 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*$" } }, "com.amazonaws.cognitoidentityprovider#EmailMfaSettingsType": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether email message MFA is active for a user. When the value of this\n parameter is Enabled, the user will be prompted for MFA during all sign-in\n attempts, unless device tracking is turned on and the device has been trusted.
Specifies whether email message MFA is the user's preferred method.
" } } }, "traits": { "smithy.api#documentation": "User preferences for multi-factor authentication with email messages. Activates or\n deactivates email MFA and sets it as the preferred MFA method when multiple methods are\n available. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "com.amazonaws.cognitoidentityprovider#EmailMfaSubjectType": { "type": "string", "traits": { "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+$" } }, "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 20000 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+$" } }, "com.amazonaws.cognitoidentityprovider#EmailNotificationSubjectType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 140 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+$" } }, "com.amazonaws.cognitoidentityprovider#EmailSendingAccountType": { "type": "enum", "members": { "COGNITO_DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COGNITO_DEFAULT" } }, "DEVELOPER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEVELOPER" } } } }, "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageByLinkType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 20000 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*$" } }, "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 20000 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*$" } }, "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectByLinkType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 140 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+$" } }, "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 140 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+$" } }, "com.amazonaws.cognitoidentityprovider#EnableSoftwareTokenMFAException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when there is a code mismatch and the service fails to\n configure the software token TOTP multi-factor authentication (MFA).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#EncryptionKeyArnType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?$" } }, "com.amazonaws.cognitoidentityprovider#EncryptionKeyType": { "type": "enum", "members": { "AWS_OWNED_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OWNED_KEY" } }, "CUSTOMER_MANAGED_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED_KEY" } } } }, "com.amazonaws.cognitoidentityprovider#EumsSmsConfigurationType": { "type": "structure", "members": { "CallerArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The ARN of the IAM role that Amazon Cognito assumes to send SMS messages through Amazon Web Services\n End User Messaging SMS. The role must grant permission to call the\n sms-voice:SendTextMessage operation.
The external ID that Amazon Cognito includes when it assumes the CallerArn role.\n Use this value as a condition in the role trust policy to prevent the confused deputy\n problem.
The origination identity that Amazon Web Services End User Messaging SMS uses to send messages to your users. This value can be one of the following:
\nA phone number \u2013 A long code, toll-free number, or short code\n that is assigned to your account.
\nA sender ID \u2013 An alphabetic name that identifies the message sender\n in supported countries.
\nA phone pool \u2013 A group of phone numbers that Amazon Web Services End User\n Messaging SMS selects from when it sends messages.
\nYou can provide an E.164 phone number or the ARN of the phone number, sender ID, or\n phone pool. Amazon Web Services End User Messaging SMS evaluates IAM authorization with the value\n that you provide. If the permissions policy of your CallerArn role scopes\n the sms-voice:SendTextMessage resource to a specific ARN, provide that same\n ARN. If the formats do not match, requests fail with an\n InvalidSmsRoleAccessPolicyException.
Depending on the destination country, you must provide an origination identity. For\n country-specific requirements, see Supported\n countries and regions for SMS messaging in the Amazon Web Services End User Messaging SMS\n User Guide.
" } }, "ConfigurationSetName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The name of the Amazon Web Services End User Messaging SMS configuration set that Amazon Cognito\n applies to messages, for logging and event destinations. If you omit this member,\n Amazon Cognito sends messages without applying a configuration set.
" } }, "InEntityId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The principal entity ID required by India's Distributed Ledger Technology (DLT) regulations for SMS messages.
" } }, "InTemplateId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The registered template ID for the message template required by India's DLT regulations for SMS messages.
" } }, "Region": { "target": "com.amazonaws.cognitoidentityprovider#RegionCodeType", "traits": { "smithy.api#documentation": "The Amazon Web Services Region of the Amazon Web Services End User Messaging SMS resources that Amazon Cognito uses to send messages. Amazon Web Services End User Messaging SMS must be available in your user pool's Region.
\nIf you omit this parameter, Amazon Cognito uses the same Region as your user pool. You can also set this parameter to your user pool's Region explicitly. Amazon Cognito rejects any other value with an InvalidParameterException.
The configuration that Amazon Cognito uses to send SMS messages through Amazon Web Services End User\n Messaging SMS. Provide this structure in the EumsSms member of\n SmsConfigurationType to use Amazon Web Services End User Messaging SMS instead of\n Amazon SNS.
The source IP address of your user's device.
" } }, "DeviceName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The user's device name.
" } }, "Timezone": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The user's time zone.
" } }, "City": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The user's city.
" } }, "Country": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The user's country.
" } } }, "traits": { "smithy.api#documentation": "The context data that your application submitted in an authentication request with\n threat protection, as displayed in an AdminListUserAuthEvents\n response.
Your feedback to the authentication event. When you provide a FeedbackValue\nvalue of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito\nhas evaluated some level of risk. When you provide a FeedbackValue value of\ninvalid, you tell Amazon Cognito that you don't trust a user session, or you \ndon't believe that Amazon Cognito evaluated a high-enough risk level.
The submitter of the event feedback. For example, if you submit event feedback in the\n Amazon Cognito console, this value is Admin.
The date that you or your user submitted the feedback.
" } } }, "traits": { "smithy.api#documentation": "The feedback that your application submitted to a threat protection event log, as\n displayed in an AdminListUserAuthEvents response.
The action taken by adaptive authentication. If NoRisk, your user pool\n took no action. If AccountTakeover, your user pool applied the adaptive\n authentication automated response that you configured. If Block, your user\n pool prevented the attempt.
The risk level that adaptive authentication assessed for the authentication\n event.
" } }, "CompromisedCredentialsDetected": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "Indicates whether compromised credentials were detected during an authentication\n event.
" } } }, "traits": { "smithy.api#documentation": "The risk evaluation by adaptive authentication, as displayed in an\n AdminListUserAuthEvents response. Contains evaluations of\n compromised-credentials detection and assessed risk level and action taken by adaptive\n authentication.
The message returned when the expired code exception is thrown.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown if a code has expired.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsType" } }, "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsType": { "type": "enum", "members": { "ADMIN_NO_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADMIN_NO_SRP_AUTH" } }, "CUSTOM_AUTH_FLOW_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_AUTH_FLOW_ONLY" } }, "USER_PASSWORD_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_PASSWORD_AUTH" } }, "ALLOW_ADMIN_USER_PASSWORD_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_ADMIN_USER_PASSWORD_AUTH" } }, "ALLOW_CUSTOM_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_CUSTOM_AUTH" } }, "ALLOW_USER_PASSWORD_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_USER_PASSWORD_AUTH" } }, "ALLOW_USER_SRP_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_USER_SRP_AUTH" } }, "ALLOW_REFRESH_TOKEN_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_REFRESH_TOKEN_AUTH" } }, "ALLOW_USER_AUTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_USER_AUTH" } }, "ALLOW_TOKEN_EXCHANGE_DELEGATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_TOKEN_EXCHANGE_DELEGATION" } }, "ALLOW_TOKEN_EXCHANGE_IMPERSONATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW_TOKEN_EXCHANGE_IMPERSONATION" } } } }, "com.amazonaws.cognitoidentityprovider#FailoverType": { "type": "structure", "members": { "SecondaryRegion": { "target": "com.amazonaws.cognitoidentityprovider#RegionNameType", "traits": { "smithy.api#documentation": "The secondary Amazon Web Services Region to use for failover when the primary region becomes unavailable.
", "smithy.api#required": {} } }, "PrimaryRoute53HealthCheckId": { "target": "com.amazonaws.cognitoidentityprovider#HealthCheckIdType", "traits": { "smithy.api#documentation": "The ID of the Amazon Web Services Route53 healthcheck that controls routing. If the healthcheck is healthy,\n traffic will be routed to the primary replica, and if the healthcheck is unhealthy,\n traffic will be routed to the secondary region.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies failover configuration for multi-region user pool domains. Contains settings for the secondary region and health check configuration.
" } }, "com.amazonaws.cognitoidentityprovider#FeatureType": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when a feature that you attempted to use or configure\n isn't included in your user pool's current feature plan. This can occur\n when:
\nYou configure a feature that your feature plan doesn't support.
\nYou make a request that uses a feature that requires a higher feature\n plan.
\nTo resolve this issue, upgrade your user pool to a feature plan that includes the\n feature.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cognitoidentityprovider#FeedbackValueType": { "type": "enum", "members": { "VALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Valid" } }, "INVALID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Invalid" } } } }, "com.amazonaws.cognitoidentityprovider#FirehoseConfigurationType": { "type": "structure", "members": { "StreamArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The ARN of an Amazon Data Firehose stream that's the destination for threat protection log\n export.
" } } }, "traits": { "smithy.api#documentation": "Configuration for the Amazon Data Firehose stream destination of user activity log export with\n threat protection.
" } }, "com.amazonaws.cognitoidentityprovider#ForbiddenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when WAF doesn't allow your request based on a web ACL\n that's associated with your user pool.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when WAF doesn't allow your request based on a web\n ACL that's associated with your user pool.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cognitoidentityprovider#ForceAliasCreation": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.cognitoidentityprovider#ForgetDevice": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ForgetDeviceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Given a device key, deletes a remembered device as the currently signed-in user. For\n more information about device authentication, see Working with user devices in your user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The unique identifier, or device key, of the device that the user wants to\n forget.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to forget the device.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ForgotPassword": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ForgotPasswordRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ForgotPasswordResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Sends a password-reset confirmation code to the email address or phone number of the\n requested username. The message delivery method is determined by the user's\n available attributes and the AccountRecoverySetting configuration of the\n user pool.
For the Username parameter, you can use the username or an email, phone,\n or preferred username alias.
If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an\n InvalidParameterException error . If your app client has a client\n secret and you don't provide a SECRET_HASH parameter, this API returns\n NotAuthorizedException.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe ID of the user pool app client associated with the current signed-in user.
", "smithy.api#required": {} } }, "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash, see Computing secret hash values.
Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to reset a user's password.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ForgotPasswordResponse": { "type": "structure", "members": { "CodeDeliveryDetails": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType", "traits": { "smithy.api#documentation": "Information about the phone number or email address that Amazon Cognito sent the\n password-recovery code to.
" } } }, "traits": { "smithy.api#documentation": "The response from Amazon Cognito to a request to reset a password.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GenerateSecret": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.cognitoidentityprovider#GetCSVHeader": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetCSVHeaderRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetCSVHeaderResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, generates a comma-separated value (CSV) list populated with\n available user attributes in the user pool. This list is the header for the CSV file\n that determines the users in a user import job. Save the content of\n CSVHeader in the response as a .csv file and populate it\n with the usernames and attributes of users that you want to import. For more information\n about CSV user import, see Importing users from a CSV file.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that you want to import users into.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to get the header information of the CSV file for the user\n import job.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetCSVHeaderResponse": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the requested user pool.
" } }, "CSVHeader": { "target": "com.amazonaws.cognitoidentityprovider#ListOfStringTypes", "traits": { "smithy.api#documentation": "A comma-separated list of attributes from your user pool. Save this output to a\n .csv file and populate it with the attributes of the users that you\n want to import.
Represents the response from the server to the request to get the header information\n of the CSV file for the user import job.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetClientToken": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetClientTokenRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetClientTokenResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Issues an access token for machine-to-machine (M2M) authorization. Your app client\n provides its client ID and secret, and receives an access token that authorizes requests\n to your resource servers.
\nTo use this operation, you must configure the app client with a client secret and\n enable the ALLOW_CLIENT_TOKEN_AUTH authentication flow. The\n ALLOW_CLIENT_TOKEN_AUTH flow is mutually exclusive with user authentication\n flows. It must be the only authentication flow that you configure for the app client. For\n more information, see Scopes, M2M, and resource servers.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe ID of the app client that requests the access token. The app client must have a\n client secret and the ALLOW_CLIENT_TOKEN_AUTH authentication flow.
An active secret for the app client.
", "smithy.api#required": {} } }, "Scopes": { "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", "traits": { "smithy.api#documentation": "The custom scopes to authorize in the access token, in the format\n resource-server-identifier/scope-name. Each scope must belong to a\n resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the\n scopes that are configured for the app client.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
The access token that Amazon Cognito issues for the app client, and its metadata.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetDerivedToken": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetDerivedTokenRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetDerivedTokenResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#documentation": "Exchanges an existing token for a new token that is scoped and audience-bound for a\n specific downstream service, following the OAuth 2.0 Token Exchange grant type. For\n more information about the OAuth 2.0 Token Exchange grant type, see\n RFC 8693 - OAuth 2.0 Token\n Exchange on the IETF website. Present a SubjectToken, the\n credential that you already hold, to receive a new token appropriate for calling a\n specific resource server or audience.
If you also present an ActorToken that identifies an intermediary\n service, the issued token carries an act claim that identifies the\n intermediary, and downstream services can distinguish a user acting directly from an\n intermediary acting on the user's behalf. If you don't present an\n ActorToken, the issued token appears as if the user acted\n directly.
To use this operation, you must have IAM credentials, or you must present the\n requesting app client's ClientId and, if the client has a secret,\n ClientSecret, in the request.
The requesting app client must have ALLOW_TOKEN_EXCHANGE_IMPERSONATION\n or ALLOW_TOKEN_EXCHANGE_DELEGATION in its ExplicitAuthFlows\n (depending on whether you include an ActorToken), or the request\n fails.
The ID of the app client that requests the token exchange.
", "smithy.api#required": {} } }, "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { "smithy.api#documentation": "The client secret of the requested app client, if the client has a secret.
" } }, "SubjectToken": { "target": "com.amazonaws.cognitoidentityprovider#GetDerivedTokenTokenModelType", "traits": { "smithy.api#documentation": "The token that you want to exchange for a new token. This is the credential that\n represents the identity of the party on behalf of whom the request is being\n made.
", "smithy.api#required": {} } }, "SubjectTokenType": { "target": "com.amazonaws.cognitoidentityprovider#TokenTypeIdentifierType", "traits": { "smithy.api#documentation": "The type of the SubjectToken that you want to exchange. Valid\n values:
\n ACCESS_TOKEN \u2013 The subject token is an access token.
\n ID_TOKEN \u2013 The subject token is an ID token.
\n SAML2 \u2013 The subject token is a SAML 2.0 assertion.
The name of the third-party identity provider that issued the\n SubjectToken, if the subject token isn't a Amazon Cognito token. Provide this\n value when your SubjectToken came from a SAML or OIDC provider that you\n registered with your user pool, so that Amazon Cognito can validate it against that provider's\n configuration. Omit this parameter for a Amazon Cognito ID or access token.
A token that identifies the intermediary service that is exchanging the token on\n behalf of the user. When you provide an ActorToken, the token that\n Amazon Cognito issues carries an act claim that identifies the intermediary,\n so that downstream services can distinguish a user acting directly from an\n intermediary acting on the user's behalf.
The type of the ActorToken that you provide. Required when you\n provide an ActorToken. Valid values:
\n ACCESS_TOKEN \u2013 The actor token is an access token.
\n ID_TOKEN \u2013 The actor token is an ID token.
\n SAML2 \u2013 The actor token is a SAML 2.0 assertion.
The name of the third-party identity provider that issued the\n ActorToken, if the actor token isn't a Amazon Cognito token.
The scopes that you want the new token to have. Amazon Cognito issues a token with the\n intersection of these requested scopes, the scopes of your\n SubjectToken, and the scopes that are allowed for the requesting app\n client. If you don't specify any scopes, Amazon Cognito issues a token with the same scopes as\n your SubjectToken.
The logical name of the target service where you intend to use the issued token.\n You can't request both Audiences and Resources in the same\n request.
The identifier of a resource server in your user pool where you intend to use the\n issued token. You can't request both Resources and\n Audiences in the same request.
The type of token that you want Amazon Cognito to issue. Valid values:
\n\n ACCESS_TOKEN \u2013 Issues an access token.
\n ID_TOKEN \u2013 Issues an ID token.
Amazon Cognito can't issue a SAML assertion, so SAML2 isn't a valid value for\n this parameter.
Represents the request to exchange a subject token for a new token.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetDerivedTokenResponse": { "type": "structure", "members": { "IssuedToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "The token that Amazon Cognito issued in response to the token exchange request.
", "smithy.api#required": {} } }, "IssuedTokenType": { "target": "com.amazonaws.cognitoidentityprovider#IssuedTokenTypeIdentifierType", "traits": { "smithy.api#documentation": "The type of the token in the IssuedToken parameter. Valid\n values:
\n ACCESS_TOKEN \u2013 The issued token is an access token.
\n ID_TOKEN \u2013 The issued token is an ID token.
The type of the issued token. For example, Bearer.
The number of seconds until the issued token expires.
" } }, "Scopes": { "target": "com.amazonaws.cognitoidentityprovider#ScopeListType", "traits": { "smithy.api#documentation": "The scopes that Amazon Cognito granted in the issued token.
" } } }, "traits": { "smithy.api#documentation": "Represents the response to a token exchange request.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetDerivedTokenTokenModelType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 131072 }, "smithy.api#pattern": "^[A-Za-z0-9-_+/=.]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#GetDevice": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetDeviceRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetDeviceResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Given a device key, returns information about a remembered device for the current\n user. For more information about device authentication, see Working with user devices in your user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe key of the device that you want to get information about.
", "smithy.api#required": {} } }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
Represents the request to get the device.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetDeviceResponse": { "type": "structure", "members": { "Device": { "target": "com.amazonaws.cognitoidentityprovider#DeviceType", "traits": { "smithy.api#documentation": "Details of the requested device. Includes device information, last-accessed and\n created dates, and the device key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Gets the device response.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetGroup": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetGroupRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetGroupResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID and a group name, returns information about the user\n group.
\nFor more information about user pool groups, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the group that you want to get information about.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the group that you want to query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetGroupResponse": { "type": "structure", "members": { "Group": { "target": "com.amazonaws.cognitoidentityprovider#GroupType", "traits": { "smithy.api#documentation": "A container for the requested group. Includes description, precedence, and IAM role\n values.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifier": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifierRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetIdentityProviderByIdentifierResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given the identifier of an identity provider (IdP), for example\n examplecorp, returns information about the user pool configuration for\n that IdP. For more information about IdPs, see Third-party IdP sign-in.
The ID of the user pool where you want to get information about the IdP.
", "smithy.api#required": {} } }, "IdpIdentifier": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifierType", "traits": { "smithy.api#documentation": "The identifier that you assigned to your user pool. The identifier is an alternative\n name for an IdP that is distinct from the IdP name. For example, an IdP with a name of\n MyIdP might have an identifier of the email domain\n example.com.
The configuration of the IdP in your user pool. Includes additional identifiers, the\n IdP name and type, and trust-relationship details like the issuer URL.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns the logging configuration. User pools can export\n message-delivery error and threat-protection activity logs to external Amazon Web Services services. For more information, see Exporting user pool logs.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that has the logging configuration that you want to\n view.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetLogDeliveryConfigurationResponse": { "type": "structure", "members": { "LogDeliveryConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType", "traits": { "smithy.api#documentation": "The logging configuration of the requested user pool. Includes types of logs\n configured and their destinations.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetProvisionedLimit": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetProvisionedLimitRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetProvisionedLimitResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns the current provisioned limit for a specific API category.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe limit to retrieve. Specify the limit class and the attributes that identify the\n limit.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetProvisionedLimitResponse": { "type": "structure", "members": { "Limit": { "target": "com.amazonaws.cognitoidentityprovider#LimitType", "traits": { "smithy.api#documentation": "The provisioned and default limit values for the requested limit.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetSigningCertificate": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetSigningCertificateRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetSigningCertificateResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns the signing certificate for SAML 2.0 federation.
\nIssued certificates are valid for 10 years from the date of issue. Amazon Cognito issues and\n assigns a new signing certificate annually. This renewal process returns a new value in\n the response to GetSigningCertificate, but doesn't invalidate the original\n certificate.
For more information, see Signing SAML requests.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to view the signing certificate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Request to get a signing certificate from Amazon Cognito.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetSigningCertificateResponse": { "type": "structure", "members": { "Certificate": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The x.509 certificate that signs SAML 2.0 authentication requests for your user\n pool.
" } } }, "traits": { "smithy.api#documentation": "Response from Amazon Cognito for a signing certificate request.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshToken": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenReuseException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Given a refresh token, issues new ID, access, and optionally refresh tokens for the\n user who owns the submitted token. This operation issues a new refresh token and\n invalidates the original refresh token after an optional grace period when refresh token\n rotation is enabled. If refresh token rotation is disabled, issues new ID and access\n tokens only.
", "smithy.api#optionalAuth": {} } }, "com.amazonaws.cognitoidentityprovider#GetTokensFromRefreshTokenRequest": { "type": "structure", "members": { "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid refresh token that can authorize the request for new tokens. When refresh\n token rotation is active in the requested app client, this token is invalidated after\n the request is complete and after an optional grace period.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The app client that issued the refresh token to the user who wants to request new\n tokens.
", "smithy.api#required": {} } }, "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { "smithy.api#documentation": "The client secret of the requested app client, if the client has a secret.
" } }, "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { "smithy.api#documentation": "When you enable device remembering, Amazon Cognito issues a device key that you can use for\n device authentication that bypasses multi-factor authentication (MFA). To implement\n GetTokensFromRefreshToken in a user pool with device remembering, you\n must capture the device key from the initial authentication request. If your application\n doesn't provide the key of a registered device, Amazon Cognito issues a new one. You must\n provide the confirmed device key in this request if device remembering is enabled in\n your user pool.
For more information about device remembering, see Working with devices.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Given a user pool ID or app client, returns information about classic hosted UI\n branding that you applied, if any. Returns user-pool level branding information if no\n app client branding is applied, or if you don't specify an app client ID. Returns\n an empty object if you haven't applied hosted UI branding to either the client or\n the user pool. For more information, see Hosted UI (classic) branding.
" } }, "com.amazonaws.cognitoidentityprovider#GetUICustomizationRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that you want to query for branding settings.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to query for branding settings.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetUICustomizationResponse": { "type": "structure", "members": { "UICustomization": { "target": "com.amazonaws.cognitoidentityprovider#UICustomizationType", "traits": { "smithy.api#documentation": "Information about the classic hosted UI custom CSS and logo-image branding that you\n applied to the user pool or app client.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetUser": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetUserRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetUserResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Gets user attributes and and MFA settings for the currently signed-in user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nGiven an attribute name, sends a user attribute verification code for the specified\n attribute name to the currently signed-in user.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The name of the attribute that the user wants to verify, for example\n email.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to get user attribute verification.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserAttributeVerificationCodeResponse": { "type": "structure", "members": { "CodeDeliveryDetails": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType", "traits": { "smithy.api#documentation": "Information about the delivery destination of the user attribute verification\n code.
" } } }, "traits": { "smithy.api#documentation": "The verification code response returned by the server response to get the user\n attribute verification code.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserAuthFactors": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetUserAuthFactorsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetUserAuthFactorsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Lists the authentication options for the currently signed-in user. Returns the\n following:
\nThe user's multi-factor authentication (MFA) preferences.
\nThe user's options for choice-based authentication with the\n USER_AUTH flow.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The name of the user who is eligible for the authentication factors in the\n response.
", "smithy.api#required": {} } }, "PreferredMfaSetting": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The challenge method that Amazon Cognito returns to the user in response to sign-in requests.\n Users can prefer SMS message, email message, or TOTP MFA.
" } }, "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.
The authentication types that are available to the user with USER_AUTH\n sign-in, for example [\"PASSWORD\", \"WEB_AUTHN\"].
\n PASSWORD can only be used as a first authentication factor.\n SOFTWARE_TOKEN can only be used as an MFA factor.\n EMAIL_OTP, SMS_OTP, and WEB_AUTHN can be\n used as either a first authentication factor or an MFA factor. WEB_AUTHN\n is available as an MFA factor only when passkey MFA is enabled at the user pool\n level.
Retrieves the session configuration for a user pool app client. If you have never\n called SetUserPoolClientSessionConfiguration for the app client, this\n operation returns the default SSO session maximum validity of 60\n minutes.
The ID of the user pool that contains the app client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client where you want to retrieve the session\n configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserPoolClientSessionConfigurationResponse": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the app client.
" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that the session configuration applies to.
" } }, "SSOSession": { "target": "com.amazonaws.cognitoidentityprovider#ClientSSOSessionConfigType", "traits": { "smithy.api#documentation": "The SSO session settings for the app client.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfig": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators\n and for multi-factor authentication (MFA). This operation describes the\n following:
\nThe WebAuthn relying party (RP) ID and user-verification settings.
\nThe required, optional, or disabled state of MFA for all user pool\n users.
\nThe message templates for email and SMS MFA.
\nThe enabled or disabled state of time-based one-time password (TOTP)\n MFA.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to query WebAuthn and MFA configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserPoolMfaConfigResponse": { "type": "structure", "members": { "SmsMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", "traits": { "smithy.api#documentation": "Shows user pool configuration for SMS message MFA. Includes the message template and\n the SMS message sending configuration for Amazon SNS.
" } }, "SoftwareTokenMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType", "traits": { "smithy.api#documentation": "Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes\n TOTP enabled or disabled state.
" } }, "EmailMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailMfaConfigType", "traits": { "smithy.api#documentation": "Shows configuration for user pool email message MFA and sign-in with one-time\n passwords (OTPs). Includes the subject and body of the email message template for\n sign-in and MFA messages. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { "smithy.api#documentation": "Displays the state of multi-factor authentication (MFA) as on, off, or optional. When\n ON, all users must set up MFA before they can sign in. When\n OPTIONAL, your application must make a client-side determination of\n whether a user wants to register an MFA device. For user pools with adaptive\n authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login\n doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in\n API responses and in managed login for users who have chosen and configured a preferred\n MFA factor.
Shows user pool configuration for sign-in with passkey authenticators such as\n biometric devices and security keys. Includes relying-party configuration,\n user-verification requirements, and whether passkeys can satisfy MFA\n requirements.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserPoolSessionConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolSessionConfigurationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GetUserPoolSessionConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Retrieves the session tracking configuration for a user pool, including whether session\n tracking is enabled and the pool-wide maximum number of active token sessions for\n each user. If you have never called SetUserPoolSessionConfiguration for the\n user pool, this operation returns the default values: UserSessionTracking as\n DISABLED and a MaxPerUser value of 20.
The ID of the user pool where you want to retrieve the session configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserPoolSessionConfigurationResponse": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that the session configuration applies to.
" } }, "UserSessionTracking": { "target": "com.amazonaws.cognitoidentityprovider#UserSessionTrackingType", "traits": { "smithy.api#documentation": "Indicates whether session tracking is enabled for the user pool.
" } }, "TokenSession": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTokenSessionConfigType", "traits": { "smithy.api#documentation": "The pool-wide token session settings for the user pool.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserRequest": { "type": "structure", "members": { "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
Represents the request to get information about the user.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GetUserResponse": { "type": "structure", "members": { "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you requested.
", "smithy.api#required": {} } }, "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { "smithy.api#documentation": "An array of name-value pairs representing user attributes.
\nCustom attributes are prepended with the custom: prefix.
\n This response parameter is no longer supported. It provides\n information only about SMS MFA configurations. It doesn't provide information about\n time-based one-time password (TOTP) software token MFA configurations. To look up\n information about either type of MFA configuration, use UserMFASettingList\n instead.
" } }, "PreferredMfaSetting": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The user's preferred MFA. Users can prefer SMS message, email message, or TOTP\n MFA.
" } }, "UserMFASettingList": { "target": "com.amazonaws.cognitoidentityprovider#UserMFASettingListType", "traits": { "smithy.api#documentation": "The MFA options that are activated for the user. The possible values in this list are\n SMS_MFA, EMAIL_OTP, and\n SOFTWARE_TOKEN_MFA.
Represents the response from the server from the request to get information about the\n user.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GlobalSignOut": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#GlobalSignOutRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#GlobalSignOutResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call\n this operation when your user signs out of your app. This results in the following\n behavior.
\nAmazon Cognito no longer accepts token-authorized user operations\n that you authorize with a signed-out user's access tokens. For more information,\n see Using the Amazon Cognito user pools API and user pool\n endpoints.
\nAmazon Cognito returns an Access Token has been revoked error when your\n app attempts to authorize a user pools API request with a revoked access token\n that contains the scope aws.cognito.signin.user.admin.
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with\n ServerSideTokenCheck enabled for its user pool IdP\n configuration in CognitoIdentityProvider.
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh\n requests.
\nOther requests might be valid until your user's token expires. This operation\n doesn't clear the managed login session cookie. To clear the session for\n a user who signed in with managed login or the classic hosted UI, direct their browser\n session to the logout endpoint.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
Represents the request to sign out all devices.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#GlobalSignOutResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response to the request to sign out all devices.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#GroupExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters a group that already exists in the user\n pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#GroupListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#GroupType" } }, "com.amazonaws.cognitoidentityprovider#GroupNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" } }, "com.amazonaws.cognitoidentityprovider#GroupType": { "type": "structure", "members": { "GroupName": { "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { "smithy.api#documentation": "The name of the group.
" } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the group.
" } }, "Description": { "target": "com.amazonaws.cognitoidentityprovider#DescriptionType", "traits": { "smithy.api#documentation": "A friendly description of the group.
" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the group. If a group has the highest\n priority of a user's groups, users who authenticate with an identity pool get\n credentials for the RoleArn that's associated with the group.
A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher ornull Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles and\n cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim isn't\n set in users' tokens.
The default Precedence value is null.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A user pool group. Contains details about the group and the way that it contributes to\n IAM role decisions with identity pools. Identity pools can make decisions about the\n IAM role to assign based on groups: users get credentials for the role associated with\n their highest-priority group.
" } }, "com.amazonaws.cognitoidentityprovider#HealthCheckIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 } } }, "com.amazonaws.cognitoidentityprovider#HexStringType": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-fA-F]+$" } }, "com.amazonaws.cognitoidentityprovider#HttpHeader": { "type": "structure", "members": { "headerName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The header name.
" } }, "headerValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The header value.
" } } }, "traits": { "smithy.api#documentation": "The HTTP header in the ContextData parameter.
The ID of the user pool associated with the IdP.
" } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { "smithy.api#documentation": "A friendly name for the IdP.
" } }, "ProviderType": { "target": "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType", "traits": { "smithy.api#documentation": "The type of IdP. Either SAML, OIDC, or a named social identity provider.
" } }, "ProviderDetails": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDetailsType", "traits": { "smithy.api#documentation": "The scopes, URLs, and identifiers for your external identity provider. The following\nexamples describe the provider detail keys for each IdP type. These values and their\nschema are subject to change. Social IdP authorize_scopes values must match\nthe values listed here.
Amazon Cognito accepts the following elements when it can't discover endpoint\n URLs from oidc_issuer: attributes_url,\n authorize_url, jwks_uri,\n token_url.
Create or update request: \"ProviderDetails\": {\n \"attributes_request_method\": \"GET\", \"attributes_url\":\n \"https://auth.example.com/userInfo\", \"authorize_scopes\": \"openid profile\n email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n \"client_id\": \"1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"jwks_uri\":\n \"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n \"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n }\n
Describe response: \"ProviderDetails\": { \"attributes_request_method\":\n \"GET\", \"attributes_url\": \"https://auth.example.com/userInfo\",\n \"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"openid\n profile email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n \"client_id\": \"1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"jwks_uri\":\n \"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n \"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n }\n
Create or update request with Metadata URL: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataURL\":\n \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\" }\n
Create or update request with Metadata file: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \n \"MetadataFile\": \"[metadata XML]\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\" }\n
The value of MetadataFile must be the plaintext metadata document with all \n quote (\") characters escaped by backslashes.
Describe response: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"ActiveEncryptionCertificate\": \"[certificate]\",\n \"MetadataURL\": \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\", \"SLORedirectBindingURI\":\n \"https://auth.example.com/slo/saml\", \"SSORedirectBindingURI\":\n \"https://auth.example.com/sso/saml\" }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"profile postal_code\", \"client_id\":\n \"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n \"provider-app-client-secret\"\n
Describe response: \"ProviderDetails\": { \"attributes_url\":\n \"https://api.amazon.com/user/profile\", \"attributes_url_add_attributes\":\n \"false\", \"authorize_scopes\": \"profile postal_code\", \"authorize_url\":\n \"https://www.amazon.com/ap/oa\", \"client_id\":\n \"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"token_request_method\": \"POST\",\n \"token_url\": \"https://api.amazon.com/auth/o2/token\" }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"email profile openid\", \"client_id\":\n \"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n \"provider-app-client-secret\" }\n
Describe response: \"ProviderDetails\": { \"attributes_url\":\n \"https://people.googleapis.com/v1/people/me?personFields=\",\n \"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"email\n profile openid\", \"authorize_url\":\n \"https://accounts.google.com/o/oauth2/v2/auth\", \"client_id\":\n \"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n \"provider-app-client-secret\", \"oidc_issuer\":\n \"https://accounts.google.com\", \"token_request_method\": \"POST\",\n \"token_url\": \"https://www.googleapis.com/oauth2/v4/token\"\n }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"email name\", \"client_id\": \"com.example.cognito\", \"private_key\": \"1EXAMPLE\", \n \"key_id\": \"2EXAMPLE\", \"team_id\": \"3EXAMPLE\" }\n
Describe response: \"ProviderDetails\": {\n \"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"email\n name\", \"authorize_url\": \"https://appleid.apple.com/auth/authorize\",\n \"client_id\": \"com.example.cognito\", \"key_id\": \"1EXAMPLE\", \"oidc_issuer\":\n \"https://appleid.apple.com\", \"team_id\": \"2EXAMPLE\",\n \"token_request_method\": \"POST\", \"token_url\":\n \"https://appleid.apple.com/auth/token\" }\n
Create or update request: \"ProviderDetails\": { \"api_version\": \"v17.0\", \n \"authorize_scopes\": \"public_profile, email\", \"client_id\": \"1example23456789\", \n \"client_secret\": \"provider-app-client-secret\" }\n
Describe response: \"ProviderDetails\": \n { \"api_version\": \"v17.0\", \"attributes_url\": \"https://graph.facebook.com/v17.0/me?fields=\", \n \"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"public_profile, email\", \n \"authorize_url\": \"https://www.facebook.com/v17.0/dialog/oauth\", \"client_id\": \n \"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"token_request_method\": \n \"GET\", \"token_url\": \"https://graph.facebook.com/v17.0/oauth/access_token\" }\n
A mapping of IdP attributes to standard and custom user pool attributes.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { "smithy.api#documentation": "A list of IdP identifiers. IdP identifiers are strings that represent friendly names\n or domain names of IdPs, for example MyIdP or\n auth.example.com. You can choose to route user authorization requests to\n the right IdP with either IdP identifiers or IdP names. For more information, see\n identity_provider and idp_identifier at Authorize endpoint.
A mapping between the authentication context class reference (ACR) levels of your user\n pool and the ACR values of the external OpenID Connect (OIDC) identity provider (IdP), so\n that your application gets a consistent step-up experience regardless of which IdP\n authenticated the user. The map is keyed by level, from Level1 through\n Level4.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A user pool identity provider (IdP). Contains information about a third-party IdP to a\n user pool, the attributes that it populates to user profiles, and the trust relationship\n between the IdP and your user pool.
" } }, "com.amazonaws.cognitoidentityprovider#IdentityProviderTypeType": { "type": "enum", "members": { "SAML": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAML" } }, "Facebook": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Facebook" } }, "Google": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Google" } }, "LoginWithAmazon": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LoginWithAmazon" } }, "SignInWithApple": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SignInWithApple" } }, "OIDC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OIDC" } } } }, "com.amazonaws.cognitoidentityprovider#IdpIdentifierType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 }, "smithy.api#pattern": "^[\\w\\s+=.@-]+$" } }, "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifierType" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.cognitoidentityprovider#ImageFileType": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 131072 } } }, "com.amazonaws.cognitoidentityprovider#ImageUrlType": { "type": "string" }, "com.amazonaws.cognitoidentityprovider#InboundFederationLambdaType": { "type": "structure", "members": { "LambdaVersion": { "target": "com.amazonaws.cognitoidentityprovider#InboundFederationLambdaVersionType", "traits": { "smithy.api#documentation": "The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
\nYou must use a LambdaVersion of V1_0 with an inbound federation\n function.
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The properties of an inbound federation Lambda trigger.
" } }, "com.amazonaws.cognitoidentityprovider#InboundFederationLambdaVersionType": { "type": "enum", "members": { "V1_0": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V1_0" } } } }, "com.amazonaws.cognitoidentityprovider#InitiateAuth": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#InitiateAuthRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#InitiateAuthResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnsupportedOperationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Declares an authentication flow and initiates sign-in for a user in the Amazon Cognito user\n directory. Amazon Cognito might respond with an additional challenge or an\n AuthenticationResult that contains the outcome of a successful\n authentication. You can't sign in a user with a federated IdP with\n InitiateAuth. For more information, see Authentication.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe authentication flow that you want to initiate. Each AuthFlow has\n linked AuthParameters that you must submit. The following are some example\n flows.
The entry point for choice-based authentication with passwords,\n one-time passwords, and WebAuthn authenticators. Request a preferred\n authentication type or review available authentication types. From the\n offered authentication types, select one in a challenge response and then\n authenticate with that method in an additional challenge response.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
\nUsername-password authentication with the Secure Remote Password (SRP)\n protocol. For more information, see Use SRP password verification in custom\n authentication flow.
\nReceive new ID and access tokens when you pass a\n REFRESH_TOKEN parameter with a valid refresh token as the\n value. For more information, see Using the refresh token.
Custom authentication with Lambda triggers. For more information, see\n Custom authentication challenge Lambda\n triggers.
\nClient-side username-password authentication with the password sent\n directly in the request. For more information about client-side and\n server-side authentication, see SDK authorization models.
\n\n ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth\n and isn't valid for InitiateAuth. ADMIN_NO_SRP_AUTH is a legacy server-side\n username-password flow and isn't valid for InitiateAuth.
The authentication parameters. These are inputs corresponding to the\n AuthFlow that you're invoking.
The following are some authentication flows and their parameters. Add a\n SECRET_HASH parameter if your app client has a client secret. Add\n DEVICE_KEY if you want to bypass multi-factor authentication with a\n remembered device.
\n USERNAME (required)
\n PREFERRED_CHALLENGE. If you don't provide a\n value for PREFERRED_CHALLENGE, Amazon Cognito responds with the\n AvailableChallenges parameter that specifies the\n available sign-in methods.
\n TARGET_ACR_VALUES. An optional, space-separated list\n of the authentication context class reference (ACR) level URIs that\n you want the user to reach. List the levels in priority order, from\n highest to lowest. Amazon Cognito attempts the highest-priority level that the\n user can satisfy, and falls back through the list. Amazon Cognito ignores any\n value that it doesn't recognize. If none of the requested values are\n valid, Amazon Cognito returns an error.
Requesting step-up authentication with this parameter requires the\n Essentials or Plus feature plan. On a lower feature plan, InitiateAuth\n returns a FeatureUnavailableInTierException. USERNAME is\n required. When you provide an ACCESS_TOKEN, you must also\n provide TARGET_ACR_VALUES. Amazon Cognito returns an error if you\n provide an ACCESS_TOKEN without\n TARGET_ACR_VALUES. The USERNAME that you\n provide must match the user that the ACCESS_TOKEN was\n issued for.
For more information about step-up authentication and how Amazon Cognito\n handles multi-factor authentication requirements, see Step-up\n authentication with ACR and AMR in the Amazon Cognito\n Developer Guide.
\n\n MAX_AGE. An optional integer that sets the maximum\n number of seconds allowed since the user last authenticated. If the\n user's most recent authentication is older than this value, Amazon Cognito\n discards the authentication-methods credit from any access token that\n you provide and processes the request as a fresh authentication toward\n the target level. The access token itself remains valid.
\n USERNAME (required)
\n SRP_A (required)
\n USERNAME (required)
\n PASSWORD (required)
\n REFRESH_TOKEN(required)
\n USERNAME (required)
\n ChallengeName: SRP_A (when doing SRP authentication\n before custom challenges)
\n SRP_A: (An SRP_A value) (when doing SRP\n authentication before custom challenges)
For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nThe ClientMetadata value is passed as input to the functions for only the\n following triggers:
Pre signup
\nPre authentication
\nUser migration
\nThis request also invokes the functions for the following triggers, but doesn't pass\n ClientMetadata:
Post authentication
\nCustom message
\nPre token generation
\nCreate auth challenge
\nDefine auth challenge
\nCustom email sender
\nCustom SMS sender
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
The ID of the app client that your user wants to sign in to.
", "smithy.api#required": {} } }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { "smithy.api#documentation": "Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "The optional session ID from a ConfirmSignUp API request. You can sign in\n a user directly from the sign-up process with the USER_AUTH authentication\n flow. When you pass the session ID to InitiateAuth, Amazon Cognito assumes the SMS\n or email message one-time verification password from ConfirmSignUp as the\n primary authentication factor. You're not required to submit this code a second\n time. This option is only valid for users who have confirmed their sign-up and are\n signing in for the first time within the authentication flow session duration of the\n session ID.
Initiates the authentication request.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#InitiateAuthResponse": { "type": "structure", "members": { "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "The name of an additional authentication challenge that you must respond to.
\nPossible challenges include the following:
\nAll of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.
\n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.
\n PASSWORD: Respond with the user's password as PASSWORD.
\n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.
\n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.
\n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n
\n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n
\n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .
\n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.
\n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.
\n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.
\n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.
\n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.
\n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.
Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.
\nIn a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.
To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n
To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n
The session identifier that links a challenge response to the initial authentication\n request. If the user must pass another challenge, Amazon Cognito returns a session ID and\n challenge parameters.
" } }, "ChallengeParameters": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeParametersType", "traits": { "smithy.api#documentation": "The required parameters of the ChallengeName challenge.
All challenges require USERNAME. They also require\n SECRET_HASH if your app client has a client secret.
The result of a successful and complete authentication request. This result is only\n returned if the user doesn't need to pass another challenge. If they must pass another\n challenge before they get tokens, Amazon Cognito returns a challenge in\n ChallengeName, ChallengeParameters, and\n Session response parameters.
This response parameter lists the available authentication challenges that users can\n select from in choice-based authentication. For example, they might be\n able to choose between passkey authentication, a one-time password from an SMS message,\n and a traditional password.
" } } }, "traits": { "smithy.api#documentation": "Initiates the authentication response.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#InitiatePointInTimeRecovery": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#InitiatePointInTimeRecoveryRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#InitiatePointInTimeRecoveryResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Initiates a point-in-time recovery of a user pool to a time in the past that you\n specify. This operation is the first step of a recovery and doesn't change your\n user pool data. Amazon Cognito pauses write operations in the user pool and\n generates a recovery preview, which might not be available immediately. The preview shows the number of entities that the recovery creates, updates,\n and deletes. To check the status of the recovery and review the preview, make a request. When the status is\n PREVIEW_GENERATED, apply the recovery with a request or discard it with a request. The time that it takes to\n generate the recovery preview doesn't depend on the size of your user\n pool.
Point-in-time recovery is a disaster recovery feature. Use it to recover from\n accidental or unauthorized changes that affect your user data, for example the\n deletion or corruption of many users. Don't use point-in-time recovery to\n remove users that were created recently or to revert changes to individual users.\n To delete or update individual users, use operations like and .
\nWhile a recovery is in progress, Amazon Cognito blocks operations that write to the user pool,\n for example user sign-up, user creation, and attribute updates. Sign-in and read\n operations continue to work, with the following exceptions:
\nUsers who must set a new password, set up MFA, or respond to a TOTP MFA\n challenge can't complete sign-in. Sign-in with the\n NEW_PASSWORD_REQUIRED, MFA_SETUP, and\n SOFTWARE_TOKEN_MFA challenges fails until the recovery\n ends.
Federated users can sign in only if they have previously signed in to the user\n pool and their attributes from the external identity provider haven't\n changed.
\nYou can't create or start user import jobs. Start your import jobs\n after the recovery ends.
\nIf you don't start or cancel the recovery within 24 hours after you initiate it,\n the recovery preview expires. Amazon Cognito then resumes write operations and doesn't\n change your user pool data. The 24-hour period includes the time that\n Amazon Cognito takes to generate the recovery preview.
\nA point-in-time recovery restores user data, including user profiles and attributes,\n group memberships, passwords, MFA settings, and passkeys. It doesn't restore user\n pool configuration, for example app clients, the attribute schema, encryption\n settings, or multi-Region replication settings. Users who changed their password after\n the recovery point keep their current password.
\nThe following requirements and limits apply to point-in-time recovery:
\nYour user pool must be on the Essentials or Plus feature plan. With the Essentials feature\n plan, you can recover your user pool to a point in time up to 1 day in the\n past. With the Plus feature plan, you can recover up to 14 days in the past.\n Your user pool must have been on the required feature plan at the recovery\n point. For example, to recover to a point in time 14 days ago, your user pool\n must have been on the Plus feature plan for the past 14 days.
\nThe recovery point must be at least 15 minutes in the past and can't be\n earlier than the creation time of the user pool.
\nA user pool can have only one active recovery at a time.
\nAn Amazon Web Services account can have up to five active recoveries at a time\n across all of its user pools. An organization in Amazon Web Services Organizations can have up\n to ten active recoveries at a time across all of its accounts.
\nYou can complete one recovery of a user pool in a 24-hour period.
\nYou can create up to three recovery previews of a user pool, ten recovery\n previews in an Amazon Web Services account, and 15 recovery previews in an\n organization in Amazon Web Services Organizations in a 24-hour period. You can create up to\n ten recovery previews of a user pool in a 30-day period.
\nYou can't initiate a recovery while a user import job is in progress in\n your user pool. Wait for the import job to complete, or stop it with a request, and then initiate the\n recovery.
\nIn a user pool with multi-Region replication, you can initiate a recovery only\n in the primary Amazon Web Services Region, and only after replication is complete.
\nIf your user pool uses a customer managed key in KMS for encryption, the key\n must remain enabled and accessible to Amazon Cognito for the duration of the\n recovery.
\nSome user pools don't support point-in-time recovery, for example some\n older user pools and user pools that contain user data with characters or\n formats that point-in-time recovery doesn't support. If your user pool\n doesn't support it, Amazon Cognito returns an error when you initiate a\n recovery. To get help with this limitation, contact Amazon Web Services Support.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that you want to recover.
", "smithy.api#required": {} } }, "RestoreTimestamp": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The point in time that you want to recover your user pool to. Amazon Cognito reverts changes\n to user data that occurred after this time. The recovery point must be at least 15\n minutes in the past and within the recovery period of your user pool feature plan: up\n to 1 day in the past with the Essentials feature plan, or up to 14 days in the past\n with the Plus feature plan.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#InitiatePointInTimeRecoveryResponse": { "type": "structure", "members": { "Restoration": { "target": "com.amazonaws.cognitoidentityprovider#RestorationType", "traits": { "smithy.api#documentation": "The details of the recovery that you initiated. Includes the recovery ID that you\n can use in later requests to describe, start, or cancel the recovery.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#IntegerType": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.cognitoidentityprovider#InternalErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when Amazon Cognito throws an internal error exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an internal error.
", "smithy.api#error": "server" } }, "com.amazonaws.cognitoidentityprovider#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an internal server error.
", "smithy.api#error": "server" } }, "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when you have an unverified email address or the identity policy\n isn't set on an email address that Amazon Cognito can access.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP\n status code: 400.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when Amazon Cognito throws an invalid Lambda response\n exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an invalid Lambda response.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#InvalidOAuthFlowException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the specified OAuth flow is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the Amazon Cognito service throws an invalid parameter\n exception.
" } }, "reasonCode": { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterExceptionReasonCodeType", "traits": { "smithy.api#documentation": "The reason code of the exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service encounters an invalid\n parameter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#InvalidParameterExceptionReasonCodeType": { "type": "string" }, "com.amazonaws.cognitoidentityprovider#InvalidPasswordException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when Amazon Cognito throws an invalid user password exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an invalid password.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the invalid SMS role access policy exception is\n thrown.
" } } }, "traits": { "smithy.api#documentation": "This exception is returned when the role provided for SMS configuration doesn't have\n permission to publish using Amazon SNS.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the role trust relationship for the SMS message is not\n valid.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the trust relationship is not valid for the role\n provided for SMS configuration. This can happen if you don't trust\n cognito-idp.amazonaws.com or the external ID provided in the role does\n not match what is provided in the SMS configuration for the user pool.
The message returned when the user pool configuration is not valid.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the user pool configuration is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#IssuedTokenTypeIdentifierType": { "type": "enum", "members": { "ACCESS_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_TOKEN" } }, "ID_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ID_TOKEN" } } } }, "com.amazonaws.cognitoidentityprovider#IssuerConfigurationType": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.cognitoidentityprovider#IssuerType", "traits": { "smithy.api#documentation": "The type of issuer configuration. Determines the token issuing behavior for the user pool.
\nThe original issuer configuration for user pools. The issuer URL is hosted in the user\n pool\u2019s region and provides OIDC endpoints specific to that region.
\nOriginal issuers have the format of\n https://cognito-idp.[region].amazonaws.com/[userPoolId]\n
Recommended for all user pools, including for multi-Region replication. Updated issuers host\n the same JWKS content in multiple regions, resulting in improved resilience and efficiency.
\nUpdated issuers have the format of\n https://issuer-cognito-idp.[region].amazonaws.com/[userPoolId], where region is the\n primary Amazon Web Services Region of your user pool.
Specifies the issuer configuration for a user pool. Contains settings that determine how tokens are issued and validated.
" } }, "com.amazonaws.cognitoidentityprovider#IssuerType": { "type": "enum", "members": { "ORIGINAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORIGINAL" } }, "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATED" } } } }, "com.amazonaws.cognitoidentityprovider#KeyConfigurationType": { "type": "structure", "members": { "KeyType": { "target": "com.amazonaws.cognitoidentityprovider#EncryptionKeyType", "traits": { "smithy.api#documentation": "The type of encryption key used for the user pool.
\nA key owned by Amazon Web Services in Key Management Service.
\nA key managed by the customer in Key Management Service. You must use a multi-region key to enable multi-region\n replication for a user pool.
\nThe Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used.
" } } }, "traits": { "smithy.api#documentation": "Specifies the key configuration for a user pool. Contains settings for encryption keys used to secure user pool data.
" } }, "com.amazonaws.cognitoidentityprovider#LambdaConfigType": { "type": "structure", "members": { "PreSignUp": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a pre sign-up Lambda trigger in a user pool. This trigger\n evaluates new users and can bypass confirmation, link a federated user profile, or block sign-up\n requests.
" } }, "CustomMessage": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "A custom message Lambda trigger. This trigger is an opportunity to customize all SMS\n and email messages from your user pool. When a custom message trigger is active, your\n user pool routes all messages to a Lambda function that returns a runtime-customized\n message subject and body for your user pool to deliver to a user.
" } }, "PostConfirmation": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a post confirmation Lambda trigger in a user pool. This\n trigger can take custom actions after a user confirms their user account and their email\n address or phone number.
" } }, "PreAuthentication": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a pre authentication trigger in a user pool. This trigger\n can evaluate and modify user sign-in events.
" } }, "PostAuthentication": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a post authentication Lambda trigger in a user pool. This\n trigger can take custom actions after a user signs in.
" } }, "DefineAuthChallenge": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a define auth challenge Lambda trigger, one of three triggers in\n the sequence of the custom authentication challenge triggers.
" } }, "CreateAuthChallenge": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a create auth challenge Lambda trigger, one of three triggers in\n the sequence of the custom authentication challenge triggers.
" } }, "VerifyAuthChallengeResponse": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The configuration of a verify auth challenge Lambda trigger, one of three triggers in\n the sequence of the custom authentication challenge triggers.
" } }, "PreTokenGeneration": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The legacy configuration of a pre token generation Lambda trigger in a user\n pool.
\nSet this parameter for legacy purposes. If you also set an ARN in\n PreTokenGenerationConfig, its value must be identical to\n PreTokenGeneration. For new instances of pre token generation triggers,\n set the LambdaArn of PreTokenGenerationConfig.
The configuration of a migrate user Lambda trigger in a user pool. This trigger\n can create user profiles when users sign in or attempt to reset their password with\n credentials that don't exist yet.
" } }, "PreTokenGenerationConfig": { "target": "com.amazonaws.cognitoidentityprovider#PreTokenGenerationVersionConfigType", "traits": { "smithy.api#documentation": "The detailed configuration of a pre token generation Lambda trigger in a user pool. If\n you also set an ARN in PreTokenGeneration, its value must be identical to\n PreTokenGenerationConfig.
The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS\n notifications from a user pool to a Lambda function that delivers the message using\n custom logic.
" } }, "CustomEmailSender": { "target": "com.amazonaws.cognitoidentityprovider#CustomEmailLambdaVersionConfigType", "traits": { "smithy.api#documentation": "The configuration of a custom email sender Lambda trigger. This trigger routes all\n email notifications from a user pool to a Lambda function that delivers the message using\n custom logic.
" } }, "KMSKeyID": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The ARN of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to\n custom sender Lambda triggers.
" } }, "InboundFederation": { "target": "com.amazonaws.cognitoidentityprovider#InboundFederationLambdaType", "traits": { "smithy.api#documentation": "The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.
" } } }, "traits": { "smithy.api#documentation": "A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.
" } }, "com.amazonaws.cognitoidentityprovider#LanguageIdType": { "type": "string", "traits": { "smithy.api#pattern": "^cognito:(default|dutch|english|french|spanish|german|bahasa-indonesia|italian|japanese|korean|portuguese-brazil|chinese-(simplified|traditional))$" } }, "com.amazonaws.cognitoidentityprovider#LimitClass": { "type": "enum", "members": { "API_CATEGORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "API_CATEGORY" } } } }, "com.amazonaws.cognitoidentityprovider#LimitDefinitionType": { "type": "structure", "members": { "LimitClass": { "target": "com.amazonaws.cognitoidentityprovider#LimitClass", "traits": { "smithy.api#documentation": "The class of the limit. For API rate limits, this is\n API_CATEGORY.
The attributes that identify the specific limit. For API rate limits, specify the\n Category key with a value like UserAuthentication or\n UserCreation.
The class and attributes that identify a specific limit at the account level.
" } }, "com.amazonaws.cognitoidentityprovider#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when Amazon Cognito throws a limit exceeded exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user exceeds the limit for a requested Amazon Web Services\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#LimitType": { "type": "structure", "members": { "LimitDefinition": { "target": "com.amazonaws.cognitoidentityprovider#LimitDefinitionType", "traits": { "smithy.api#documentation": "The definition that identifies this limit, including the class and attributes.
", "smithy.api#required": {} } }, "ProvisionedLimitValue": { "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The provisioned limit value, in requests per second (RPS). This is the rate that\n Amazon Cognito currently enforces for your account.
", "smithy.api#required": {} } }, "FreeLimitValue": { "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The default (free) limit value, in requests per second (RPS). This is the rate\n included at no additional cost.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The limit definition and current limit values for a provisioned limit.
" } }, "com.amazonaws.cognitoidentityprovider#LinkUrlType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$" } }, "com.amazonaws.cognitoidentityprovider#LinksType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#LanguageIdType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#LinkUrlType" }, "traits": { "smithy.api#length": { "min": 1, "max": 13 } } }, "com.amazonaws.cognitoidentityprovider#ListCIMDPolicies": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListCIMDPoliciesRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListCIMDPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists the Client ID Metadata Document (CIMD) policies in a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool whose CIMD policies you want to list.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is an\n identifier that you can present in an additional API request with the same parameters.\n When you include the pagination token, Amazon Cognito returns the next set of\n items after the current list. Subsequent requests return a new pagination token. By\n use of this token, you can paginate through the full list of items.
" } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of CIMD policies that you want Amazon Cognito to return in the\n response.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListCIMDPoliciesResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this\n operation. When you include a pagination token in your request, Amazon Cognito returns\n the next set of items in the list. By use of this token, you can paginate through the\n full list of items.
" } }, "CIMDPolicies": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicySummaryListType", "traits": { "smithy.api#documentation": "A summary of each CIMD policy in the user pool.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListClientMetadataURLs": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListClientMetadataURLsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListClientMetadataURLsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists the client ID metadata document URLs that Amazon Cognito has received for a\n Client ID Metadata Document (CIMD) policy, with the cache state of each URL.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the CIMD policy.
", "smithy.api#required": {} } }, "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy whose client metadata document URLs you want to\n list.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is an\n identifier that you can present in an additional API request with the same parameters.\n When you include the pagination token, Amazon Cognito returns the next set of\n items after the current list. Subsequent requests return a new pagination token. By\n use of this token, you can paginate through the full list of items.
" } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of URLs that you want Amazon Cognito to return in the\n response.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListClientMetadataURLsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this\n operation. When you include a pagination token in your request, Amazon Cognito returns\n the next set of items in the list. By use of this token, you can paginate through the\n full list of items.
" } }, "ClientMetadataURLs": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataURLListType", "traits": { "smithy.api#documentation": "The client metadata document URLs for the CIMD policy, with the cache state of each\n URL.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListDevices": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListDevicesRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListDevicesResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Lists the devices that Amazon Cognito has registered to the currently signed-in user. For more\n information about device authentication, see Working with user devices in your user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The maximum number of devices that you want Amazon Cognito to return in the response.
" } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the request to list the devices.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListDevicesResponse": { "type": "structure", "members": { "Devices": { "target": "com.amazonaws.cognitoidentityprovider#DeviceListType", "traits": { "smithy.api#documentation": "An array of devices and their details. Each entry that's returned includes device\n information, last-accessed and created dates, and the device key.
" } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the response to list devices.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListGroups": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListGroupsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListGroupsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns user pool groups and their details.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list user groups.
", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of groups that you want Amazon Cognito to return in the response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListGroupsResponse": { "type": "structure", "members": { "Groups": { "target": "com.amazonaws.cognitoidentityprovider#GroupListType", "traits": { "smithy.api#documentation": "An array of groups and their details. Each entry that's returned includes\n description, precedence, and IAM role values.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListIdentityProviders": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListIdentityProvidersRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListIdentityProvidersResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns information about configured identity providers (IdPs).\n For more information about IdPs, see Third-party IdP sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list IdPs.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#ListProvidersLimitType", "traits": { "smithy.api#documentation": "The maximum number of IdPs that you want Amazon Cognito to return in the response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListIdentityProvidersResponse": { "type": "structure", "members": { "Providers": { "target": "com.amazonaws.cognitoidentityprovider#ProvidersListType", "traits": { "smithy.api#documentation": "An array of the IdPs in your user pool. For each, the response includes identifiers,\n the IdP name and type, and trust-relationship details like the issuer URL.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListOfStringTypes": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#ListPointInTimeRecoveries": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListPointInTimeRecoveriesRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListPointInTimeRecoveriesResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists the point-in-time recoveries of a user pool, including the active recovery\n and past recoveries. The response lists the most recent recoveries first and doesn't\n include recovery previews. To get the recovery preview of a recovery, make a request.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list point-in-time recoveries.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of recoveries that you want Amazon Cognito to return in the response.\n Valid values are 1 through 60. The default value is 60.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListPointInTimeRecoveriesResponse": { "type": "structure", "members": { "Restorations": { "target": "com.amazonaws.cognitoidentityprovider#RestorationListType", "traits": { "smithy.api#documentation": "A summary of each requested recovery, including its ID, status, and the point in\n time that it restores the user pool to.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListProvidersLimitType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#ListResourceServers": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListResourceServersRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListResourceServersResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns all resource servers and their details. For more\n information about resource servers, see Access control with resource servers.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list resource servers.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#ListResourceServersLimitType", "traits": { "smithy.api#documentation": "The maximum number of resource servers that you want Amazon Cognito to return in the\n response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListResourceServersResponse": { "type": "structure", "members": { "ResourceServers": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServersListType", "traits": { "smithy.api#documentation": "An array of resource servers and the details of their configuration. For each, the\n response includes names, identifiers, and custom scopes.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists the tags that are assigned to an Amazon Cognito user pool. For more information, see\n Tagging\n resources.
" } }, "com.amazonaws.cognitoidentityprovider#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { "smithy.api#documentation": "The tags that are assigned to the user pool.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListTerms": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListTermsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListTermsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns details about all terms documents for the requested user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list terms documents.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#ListTermsRequestMaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of terms documents that you want Amazon Cognito to return in the\n response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListTermsRequestMaxResultsInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#ListTermsResponse": { "type": "structure", "members": { "Terms": { "target": "com.amazonaws.cognitoidentityprovider#TermsDescriptionListType", "traits": { "smithy.api#documentation": "A summary of the requested terms documents. Includes unique identifiers for later\n changes to the terms documents.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserImportJobs": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUserImportJobsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUserImportJobsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns user import jobs and their details. Import jobs are\n retained in user pool configuration so that you can stage, stop, start, review, and\n delete them. For more information about user import, see Importing users from a CSV file.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list import jobs.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of import jobs that you want Amazon Cognito to return in the\n response.
", "smithy.api#required": {} } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the request to list the user import jobs.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserImportJobsResponse": { "type": "structure", "members": { "UserImportJobs": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobsListType", "traits": { "smithy.api#documentation": "An array of user import jobs from the requested user pool. For each, the response\n includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.
" } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to list the user import\n jobs.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolClientSecrets": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolClientSecretsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolClientSecretsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalServerException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists all client secrets associated with a user pool app client. Returns metadata about the secrets. The response does not include pagination tokens as there are only 2 secrets at any given time and we return both with every ListUserPoolClientSecrets call. For security reasons, the response never reveals the actual secret value in ClientSecretValue.
" } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolClientSecretsRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the app client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client whose secrets you want to list.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#documentation": "The request to list client secrets for a user pool app client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolClientSecretsResponse": { "type": "structure", "members": { "ClientSecrets": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretDescriptorListType", "traits": { "smithy.api#documentation": "A list of client secret descriptors containing the identifier and creation date for each secret. For security reasons, the response never reveals the actual secret value in ClientSecretValue.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "The response containing the list of client secret metadata. This response does not include a NextToken field as all secrets are returned in a single response.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolClients": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolClientsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolClientsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, lists app clients. App clients are sets of rules for the access\n that you want a user pool to grant to one application. For more information, see App clients.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to list user pool clients.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimit", "traits": { "smithy.api#documentation": "The maximum number of app clients that you want Amazon Cognito to return in the\n response.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } }, "ClientType": { "target": "com.amazonaws.cognitoidentityprovider#ClientTypeType", "traits": { "smithy.api#documentation": "Returns only app clients of this type. For dynamic client registration\n (DCR) and other app clients, the following values are valid.
An app client not created through dynamic client registration.
\nAn app client created through dynamic client registration.
\nIf you omit ClientType, the response includes app clients of all types.\n When you set this filter, a page of results can contain fewer app clients than\n MaxResults, or none, while the response still includes a\n NextToken. Continue to request pages until the response has no\n NextToken. The app clients in the response don't include their\n type. To get the type of an app client, call\n DescribeUserPoolClient.
Represents the request to list the user pool clients.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolClientsResponse": { "type": "structure", "members": { "UserPoolClients": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientListType", "traits": { "smithy.api#documentation": "An array of app clients and their details. Includes app client ID and name.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server that lists user pool clients.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolReplicas": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolReplicasRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolReplicasResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists all replicas for a user pool, including both primary and secondary replicas. We\n recommend using pagination to ensure that the operation returns quickly and\n successfully.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool for which to list replicas.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "A pagination token for retrieving the next page of results. If this parameter is\n omitted, the operation returns the first page of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolReplicasResponse": { "type": "structure", "members": { "UserPoolReplicas": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolReplicaListType", "traits": { "smithy.api#documentation": "A list of user pool replicas, including information about their status, role, and\n Region.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "A pagination token for retrieving the next page of results. If this value is null,\n there are no more results to retrieve.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPools": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUserPoolsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists user pools and their details in the current Amazon Web Services account.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of user pools that you want Amazon Cognito to return in the response.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to list user pools.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserPoolsResponse": { "type": "structure", "members": { "UserPools": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolListType", "traits": { "smithy.api#documentation": "An array of user pools and their configuration details.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKeyType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "Represents the response to list user pools.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUserSessions": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUserSessionsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUserSessionsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Lists the active sessions for the currently signed-in user. Amazon Cognito authorizes this\n operation with the user's access token and returns all of the user's active sessions\n across every app client in the user pool, including both token sessions and SSO\n sessions. The IsCurrentSession field identifies the session that the\n calling access token belongs to. The results are eventually consistent, and new\n sessions are typically included within a few seconds.
A valid access token that Amazon Cognito issued to the user whose sessions you want to list.\n Amazon Cognito derives the user pool and username from this token.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "A pagination token that Amazon Cognito returned in a previous response. Use this value to\n retrieve the next page of results if a NextToken was included in a prior\n response.
A list of the user's active sessions. Each element describes one token session or SSO\n session.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The pagination token to use in a subsequent request to retrieve the next page of\n results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUsers": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListUsersRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListUsersResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given a user pool ID, returns a list of users and their basic details in a user\n pool.
\nThis operation is eventually consistent. You might experience a delay before results\n are up-to-date. To validate the existence or configuration of an individual user, use\n AdminGetUser.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven a user pool ID and a group name, returns a list of users in the group. For more\n information about user pool groups, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to view the membership of the requested\n group.
", "smithy.api#required": {} } }, "GroupName": { "target": "com.amazonaws.cognitoidentityprovider#GroupNameType", "traits": { "smithy.api#documentation": "The name of the group that you want to query for user membership.
", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.cognitoidentityprovider#QueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of groups that you want Amazon Cognito to return in the response. In some\n SDK contexts, this operation might return fewer items than you specify in the\n Limit parameter without having reached the end of the full list. If the\n response contains a PaginationToken, then there are more results.
This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUsersInGroupResponse": { "type": "structure", "members": { "Users": { "target": "com.amazonaws.cognitoidentityprovider#UsersListType", "traits": { "smithy.api#documentation": "An array of users who are members in the group, and their attributes.
" } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListUsersRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to display or search for users.
", "smithy.api#required": {} } }, "AttributesToGet": { "target": "com.amazonaws.cognitoidentityprovider#SearchedAttributeNamesListType", "traits": { "smithy.api#documentation": "A JSON array of user attribute names, for example given_name, that you\n want Amazon Cognito to include in the response for each user. When you don't provide an\n AttributesToGet parameter, Amazon Cognito returns all attributes for each\n user.
Use AttributesToGet with required attributes in your user pool, or in\n conjunction with Filter. Amazon Cognito returns an error if not all users in the\n results have set a value for the attribute you request. Attributes that you can't\n filter on, including custom attributes, must have a value set in every user profile\n before an AttributesToGet parameter returns results.
The maximum number of users that you want Amazon Cognito to return in the response. In some SDK\n contexts, this operation might return fewer items than you specify in the\n Limit parameter without having reached the end of the full list. If the\n response contains a PaginationToken, then there are more results.
This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } }, "Filter": { "target": "com.amazonaws.cognitoidentityprovider#UserFilterType", "traits": { "smithy.api#documentation": "A filter string of the form \"AttributeName Filter-Type \"AttributeValue\".\n Quotation marks within the filter string must be escaped using the backslash\n (\\) character. For example, \"family_name =\n \\\"Reddy\\\"\".
\n AttributeName: The name of the attribute to search for.\n You can only search for one attribute at a time.
\n\n Filter-Type: For an exact match, use =, for\n example, \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\")\n match, use ^=, for example, \"given_name ^= \\\"Jon\\\"\".\n
\n AttributeValue: The attribute value that must be matched\n for each user.
\nIf the filter string is empty, ListUsers returns all users in the user\n pool.
You can only search for the following standard attributes:
\n\n username (case-sensitive)
\n email\n
\n phone_number\n
\n name\n
\n given_name\n
\n family_name\n
\n preferred_username\n
\n cognito:user_status (called Status in the Console) (case-insensitive)
\n status (called Enabled in the Console)\n (case-sensitive)\n
\n sub\n
Custom attributes aren't searchable.
\nYou can also list users with a client-side filter. The server-side filter matches\n no more than one attribute. For an advanced search, use a client-side filter with\n the --query parameter of the list-users action in the\n CLI. When you use a client-side filter, ListUsers returns a paginated list of zero\n or more users. You can receive multiple pages in a row with zero results. Repeat the\n query with each pagination token that is returned until you receive a null\n pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface\n User Guide.
\nFor more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer\n Guide.
" } } }, "traits": { "smithy.api#documentation": "Represents the request to list users.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListUsersResponse": { "type": "structure", "members": { "Users": { "target": "com.amazonaws.cognitoidentityprovider#UsersListType", "traits": { "smithy.api#documentation": "An array of user pool users who match your query, and their attributes. Between\n different requests, you might observe variations in the sequence that users in this\n response object are sorted into. The sort order of users isn't guaranteed to follow a\n single pattern, but the paginated list from a single chain of requests won't return\n duplicates.
" } }, "PaginationToken": { "target": "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#documentation": "The response from the request to list users.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentials": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Generates a list of the currently signed-in user's registered passkey, or\n WebAuthn, credentials.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
This API operation returns a limited number of results. The pagination token is\nan identifier that you can present in an additional API request with the same parameters. When\nyou include the pagination token, Amazon Cognito returns the next set of items after the current list. \nSubsequent requests return a new pagination token. By use of this token, you can paginate \nthrough the full list of items.
" } }, "MaxResults": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialsQueryLimitType", "traits": { "smithy.api#documentation": "The maximum number of the user's passkey credentials that you want to\n return.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ListWebAuthnCredentialsResponse": { "type": "structure", "members": { "Credentials": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescriptionListType", "traits": { "smithy.api#documentation": "A list of registered passkeys for a user.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cognitoidentityprovider#PaginationKey", "traits": { "smithy.api#documentation": "The identifier that Amazon Cognito returned with the previous request to this operation. When \nyou include a pagination token in your request, Amazon Cognito returns the next set of items in \nthe list. By use of this token, you can paginate through the full list of items.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#LogConfigurationListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#LogConfigurationType" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.cognitoidentityprovider#LogConfigurationType": { "type": "structure", "members": { "LogLevel": { "target": "com.amazonaws.cognitoidentityprovider#LogLevel", "traits": { "smithy.api#documentation": "The errorlevel selection of logs that a user pool sends for detailed\n activity logging. To send userNotification activity with information\n about message delivery, choose ERROR with\n CloudWatchLogsConfiguration. To send userAuthEvents\n activity with user logs from threat protection with the Plus feature plan, choose\n INFO with one of CloudWatchLogsConfiguration,\n FirehoseConfiguration, or S3Configuration.
The source of events that your user pool sends for logging. To send error-level logs\n about user notification activity, set to userNotification. To send\n info-level logs about threat-protection user activity in user pools with the Plus\n feature plan, set to userAuthEvents.
The CloudWatch log group destination of user pool detailed activity logs, or of user\n activity log export with threat protection.
" } }, "S3Configuration": { "target": "com.amazonaws.cognitoidentityprovider#S3ConfigurationType", "traits": { "smithy.api#documentation": "The Amazon S3 bucket destination of user activity log export with threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.
" } }, "FirehoseConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#FirehoseConfigurationType", "traits": { "smithy.api#documentation": "The Amazon Data Firehose stream destination of user activity log export with threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.
" } } }, "traits": { "smithy.api#documentation": "The configuration of user event logs to an external Amazon Web Services service like\n Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.
" } }, "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you configured logging.
", "smithy.api#required": {} } }, "LogConfigurations": { "target": "com.amazonaws.cognitoidentityprovider#LogConfigurationListType", "traits": { "smithy.api#documentation": "A logging destination of a user pool. User pools can have multiple logging\n destinations for message-delivery and user-activity logs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The logging parameters of a user pool, as returned in the response to a\n GetLogDeliveryConfiguration request.
The message returned when Amazon Cognito throws an MFA method not found\n exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito can't find a multi-factor authentication\n (MFA) method.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#MFAOptionListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#MFAOptionType" } }, "com.amazonaws.cognitoidentityprovider#MFAOptionType": { "type": "structure", "members": { "DeliveryMedium": { "target": "com.amazonaws.cognitoidentityprovider#DeliveryMediumType", "traits": { "smithy.api#documentation": "The delivery medium to send the MFA code. You can use this parameter to set only the\n SMS delivery medium value.
The attribute name of the MFA option type. The only valid value is\n phone_number.
\n This data type is no longer supported. Applies only to SMS\n multi-factor authentication (MFA) configurations. Does not apply to time-based one-time\n password (TOTP) software token MFA configurations.
" } }, "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when you attempt to apply a managed login branding style to\n an app client that already has an assigned style.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType": { "type": "structure", "members": { "ManagedLoginBrandingId": { "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", "traits": { "smithy.api#documentation": "The ID of the managed login branding style.
" } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The user pool where the branding style is assigned.
" } }, "UseCognitoProvidedValues": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, applies the default branding style options. This option reverts to default\n style options that are managed by Amazon Cognito. You can modify them later in the branding\n editor.
\nWhen you specify true for this option, you must also omit values for\n Settings and Assets in the request.
A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.
The following components are not currently implemented and reserved for future\n use:
\n\n signUp\n
\n instructions\n
\n sessionTimerDisplay\n
\n languageSelector (for localization, see Managed login localization)\n
An array of image files that you want to apply to roles like backgrounds, logos, and\n icons. Each object must also indicate whether it is for dark mode, light mode, or\n browser-adaptive mode.
" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A managed login branding style that's assigned to a user pool app client.
" } }, "com.amazonaws.cognitoidentityprovider#MaxSessionsPerUserType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.cognitoidentityprovider#MessageActionType": { "type": "enum", "members": { "RESEND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESEND" } }, "SUPPRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPPRESS" } } } }, "com.amazonaws.cognitoidentityprovider#MessageTemplateType": { "type": "structure", "members": { "SMSMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsInviteMessageType", "traits": { "smithy.api#documentation": "The message template for SMS messages.
" } }, "EmailMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailInviteMessageType", "traits": { "smithy.api#documentation": "The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.
" } }, "EmailSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { "smithy.api#documentation": "The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.
" } } }, "traits": { "smithy.api#documentation": "The message template structure.
" } }, "com.amazonaws.cognitoidentityprovider#MessageType": { "type": "string" }, "com.amazonaws.cognitoidentityprovider#MetadataURLType": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 256 }, "smithy.api#pattern": "^https://[^\\s]+$" } }, "com.amazonaws.cognitoidentityprovider#NewDeviceMetadataType": { "type": "structure", "members": { "DeviceKey": { "target": "com.amazonaws.cognitoidentityprovider#DeviceKeyType", "traits": { "smithy.api#documentation": "The device key, an identifier used in generating the\n DEVICE_PASSWORD_VERIFIER for device SRP authentication.
The device group key, an identifier used in generating the\n DEVICE_PASSWORD_VERIFIER for device SRP authentication.
Information that your user pool responds with in AuthenticationResultwhen\n you configure it to remember devices and a user signs in with an unrecognized device.\n Amazon Cognito presents a new device key that you can use to set up device authentication in a \"Remember me on this device\"\n authentication model.
The message returned when the Amazon Cognito service returns a not authorized exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user isn't authorized.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cognitoidentityprovider#NotifyConfigurationType": { "type": "structure", "members": { "From": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The email address that sends the email message. The address must be either\n individually verified with Amazon Simple Email Service, or from a domain that has been verified with\n Amazon SES.
" } }, "ReplyTo": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The reply-to email address of an email template. Can be an email address in the format\n admin@example.com or Administrator\n .
The Amazon Resource Name (ARN) of the identity that is associated with the sending\n authorization policy. This identity permits Amazon Cognito to send for the email address\n specified in the From parameter.
The template for the email message that your user pool sends when a detected risk\n event is blocked.
" } }, "NoActionEmail": { "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { "smithy.api#documentation": "The template for the email message that your user pool sends when no action is taken\n in response to a detected risk.
" } }, "MfaEmail": { "target": "com.amazonaws.cognitoidentityprovider#NotifyEmailType", "traits": { "smithy.api#documentation": "The template for the email message that your user pool sends when MFA is challenged in\n response to a detected risk.
" } } }, "traits": { "smithy.api#documentation": "The configuration for Amazon SES email messages that threat protection sends to a user when\n your adaptive authentication automated response has a Notify\n action.
" } }, "com.amazonaws.cognitoidentityprovider#NotifyEmailType": { "type": "structure", "members": { "Subject": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationSubjectType", "traits": { "smithy.api#documentation": "The subject of the threat protection email notification.
", "smithy.api#required": {} } }, "HtmlBody": { "target": "com.amazonaws.cognitoidentityprovider#EmailNotificationBodyType", "traits": { "smithy.api#documentation": "The body of an email notification formatted in HTML. Choose an HtmlBody\n or a TextBody to send an HTML-formatted or plaintext message,\n respectively.
The body of an email notification formatted in plaintext. Choose an\n HtmlBody or a TextBody to send an HTML-formatted or\n plaintext message, respectively.
The template for email messages that threat protection sends to a user when your\n threat protection automated response has a Notify action.
" } }, "com.amazonaws.cognitoidentityprovider#NumberAttributeConstraintsType": { "type": "structure", "members": { "MinValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The minimum value of an attribute that is of the number data type.
" } }, "MaxValue": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The maximum length of a number attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The minimum and maximum values of an attribute that is of the number type, for example\n custom:age.
This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#OptionalArnType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^(arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?)?$" } }, "com.amazonaws.cognitoidentityprovider#PaginationKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 131072 }, "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.cognitoidentityprovider#PaginationKeyType": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.cognitoidentityprovider#PasswordHashingAlgorithmType": { "type": "enum", "members": { "BCRYPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BCRYPT" } }, "SCRYPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCRYPT" } }, "ARGON2ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARGON2ID" } }, "PBKDF2_SHA256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PBKDF2_SHA256" } } } }, "com.amazonaws.cognitoidentityprovider#PasswordHistoryPolicyViolationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "The message returned when a user's new password matches a previous password and\n doesn't comply with the password-history policy.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#PasswordHistorySizeType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 24 } } }, "com.amazonaws.cognitoidentityprovider#PasswordPolicyMinLengthType": { "type": "integer", "traits": { "smithy.api#range": { "min": 6, "max": 99 } } }, "com.amazonaws.cognitoidentityprovider#PasswordPolicyType": { "type": "structure", "members": { "MinimumLength": { "target": "com.amazonaws.cognitoidentityprovider#PasswordPolicyMinLengthType", "traits": { "smithy.api#documentation": "The minimum length of the password in the policy that you have set. This value can't\n be less than 6.
" } }, "RequireUppercase": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "The requirement in a password policy that users must include at least one uppercase\n letter in their password.
" } }, "RequireLowercase": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "The requirement in a password policy that users must include at least one lowercase\n letter in their password.
" } }, "RequireNumbers": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "The requirement in a password policy that users must include at least one number in\n their password.
" } }, "RequireSymbols": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "The requirement in a password policy that users must include at least one symbol in\n their password.
" } }, "PasswordHistorySize": { "target": "com.amazonaws.cognitoidentityprovider#PasswordHistorySizeType", "traits": { "smithy.api#documentation": "The number of previous passwords that you want Amazon Cognito to restrict each user from\n reusing. Users can't set a password that matches any of n previous\n passwords, where n is the value of PasswordHistorySize.
The number of days a temporary password is valid in the password policy. If the user\n doesn't sign in during this time, an administrator must reset their password. Defaults\n to 7. If you submit a value of 0, Amazon Cognito treats it as a null\n value and sets TemporaryPasswordValidityDays to its default value.
When you set TemporaryPasswordValidityDays for a user pool, you can\n no longer set a value for the legacy UnusedAccountValidityDays\n parameter in that user pool.
The password policy settings for a user pool, including complexity, history, and\n length requirements.
" } }, "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when a password reset is required.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a password reset is required.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#PasswordType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\S]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#PoolQueryLimitType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#PreSignedUrlType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.cognitoidentityprovider#PreTokenGenerationLambdaVersionType": { "type": "enum", "members": { "V1_0": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V1_0" } }, "V2_0": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V2_0" } }, "V3_0": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "V3_0" } } } }, "com.amazonaws.cognitoidentityprovider#PreTokenGenerationVersionConfigType": { "type": "structure", "members": { "LambdaVersion": { "target": "com.amazonaws.cognitoidentityprovider#PreTokenGenerationLambdaVersionType", "traits": { "smithy.api#documentation": "The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.
", "smithy.api#required": {} } }, "LambdaArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
\nThis parameter and the PreTokenGeneration property of\n LambdaConfig have the same value. For new instances of pre token\n generation triggers, set LambdaArn.
The properties of a pre token generation Lambda trigger.
" } }, "com.amazonaws.cognitoidentityprovider#PrecedenceType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.cognitoidentityprovider#PreconditionNotMetException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when a precondition is not met.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a precondition is not met.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes": { "type": "enum", "members": { "LEGACY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEGACY" } }, "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } } } }, "com.amazonaws.cognitoidentityprovider#PriorityType": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 2 } } }, "com.amazonaws.cognitoidentityprovider#ProviderDescription": { "type": "structure", "members": { "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { "smithy.api#documentation": "The name of the IdP, for example MySAMLProvider.
The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0,\n OIDC, and social IdPs. User pools list supported social IdPs by name in this response\n parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The details of a user pool identity provider (IdP), including name and type.
" } }, "com.amazonaws.cognitoidentityprovider#ProviderDetailsType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#ProviderNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\p{Z}]+$" } }, "com.amazonaws.cognitoidentityprovider#ProviderNameTypeV2": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+$" } }, "com.amazonaws.cognitoidentityprovider#ProviderUserIdentifierType": { "type": "structure", "members": { "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { "smithy.api#documentation": "The name of the provider, such as Facebook, Google, or Login with Amazon.
" } }, "ProviderAttributeName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The name of the provider attribute to link to, such as NameID.
The value of the provider attribute to link to, such as\n xxxxx_account.
The characteristics of a source or destination user for linking a federated user\n profile to a local user profile.
" } }, "com.amazonaws.cognitoidentityprovider#ProvidersListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ProviderDescription" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.cognitoidentityprovider#QueryLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#QueryLimitType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#RecoveryMechanismsType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#RecoveryOptionType" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.cognitoidentityprovider#RecoveryOptionNameType": { "type": "enum", "members": { "VERIFIED_EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "verified_email" } }, "VERIFIED_PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "verified_phone_number" } }, "ADMIN_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "admin_only" } } } }, "com.amazonaws.cognitoidentityprovider#RecoveryOptionType": { "type": "structure", "members": { "Priority": { "target": "com.amazonaws.cognitoidentityprovider#PriorityType", "traits": { "smithy.api#documentation": "Your priority preference for using the specified attribute in account recovery. The\n highest priority is 1.
The recovery method that this object sets a recovery option for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A recovery option for a user. The AccountRecoverySettingType data type is\n an array of this object. Each RecoveryOptionType has a priority property\n that determines whether it is a primary or secondary option.
For example, if verified_email has a priority of 1 and\n verified_phone_number has a priority of 2, your user pool\n sends account-recovery messages to a verified email address but falls back to an SMS\n message if the user has a verified phone number. The admin_only option\n prevents self-service account recovery.
This exception is throw when your application requests token refresh with a refresh\n token that has been invalidated by refresh-token rotation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#RefreshTokenRotationType": { "type": "structure", "members": { "Feature": { "target": "com.amazonaws.cognitoidentityprovider#FeatureType", "traits": { "smithy.api#documentation": "The state of refresh token rotation for the current app client.
", "smithy.api#required": {} } }, "RetryGracePeriodSeconds": { "target": "com.amazonaws.cognitoidentityprovider#RetryGracePeriodSecondsType", "traits": { "smithy.api#documentation": "When you request a token refresh with GetTokensFromRefreshToken, the\n original refresh token that you're rotating out can remain valid for a period of time of\n up to 60 seconds. This allows for client-side retries. When\n RetryGracePeriodSeconds is 0, the grace period is disabled\n and a successful request immediately invalidates the submitted refresh token.
The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.
" } }, "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 315360000 } } }, "com.amazonaws.cognitoidentityprovider#RegionCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 32 } } }, "com.amazonaws.cognitoidentityprovider#RegionNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 32 } } }, "com.amazonaws.cognitoidentityprovider#RelyingPartyIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 } } }, "com.amazonaws.cognitoidentityprovider#ReplicaRegionsType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#ReplicaRoleType": { "type": "enum", "members": { "PRIMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIMARY" } }, "SECONDARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECONDARY" } } } }, "com.amazonaws.cognitoidentityprovider#ReplicaStatusType": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.cognitoidentityprovider#ResendConfirmationCode": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#ResendConfirmationCodeRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#ResendConfirmationCodeResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Resends the code that confirms a new account for a user who has signed up in your user\n pool. Amazon Cognito sends confirmation codes to the user attribute in the\n AutoVerifiedAttributes property of your user pool. When you prompt new\n users for the confirmation code, include a \"Resend code\" option that generates a call to\n this API operation.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe ID of the user pool app client where the user signed up.
", "smithy.api#required": {} } }, "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash, see Computing secret hash values.
Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to resend the confirmation code.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#ResendConfirmationCodeResponse": { "type": "structure", "members": { "CodeDeliveryDetails": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType", "traits": { "smithy.api#documentation": "Information about the phone number or email address that Amazon Cognito sent the confirmation\n code to.
" } } }, "traits": { "smithy.api#documentation": "The response from the server when Amazon Cognito makes the request to resend a confirmation\n code.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#ResourceIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 }, "smithy.api#pattern": "^[\\w\\- ]+$" } }, "com.amazonaws.cognitoidentityprovider#ResourceListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a resource not found\n exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service can't find the requested\n resource.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$" } }, "com.amazonaws.cognitoidentityprovider#ResourceServerManagedByType": { "type": "enum", "members": { "COGNITO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COGNITO" } } } }, "com.amazonaws.cognitoidentityprovider#ResourceServerNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\w\\s+=,.@-]+$" } }, "com.amazonaws.cognitoidentityprovider#ResourceServerScopeDescriptionType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeType" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.cognitoidentityprovider#ResourceServerScopeNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+$" } }, "com.amazonaws.cognitoidentityprovider#ResourceServerScopeType": { "type": "structure", "members": { "ScopeName": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeNameType", "traits": { "smithy.api#documentation": "The name of the scope. Amazon Cognito renders custom scopes in the format\n resourceServerIdentifier/ScopeName. For example, if this parameter is\n exampleScope in the resource server with the identifier\n exampleResourceServer, you request and receive the scope\n exampleResourceServer/exampleScope.
A friendly description of a custom scope.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One custom scope associated with a user pool resource server. This data type is a\n member of ResourceServerScopeType. For more information, see \n Scopes, M2M, and API authorization with resource servers.
The ID of the user pool that contains the resource server configuration.
" } }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The name of the resource server.
" } }, "Scopes": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType", "traits": { "smithy.api#documentation": "A list of scopes that are defined for the resource server.
" } }, "ManagedBy": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerManagedByType", "traits": { "smithy.api#documentation": "This value is reserved for resource servers that Amazon Cognito manages. Resource servers that\n you create don't have this value.
" } } }, "traits": { "smithy.api#documentation": "The details of a resource server configuration and associated custom scopes in a user\n pool.
" } }, "com.amazonaws.cognitoidentityprovider#ResourceServersListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerType" } }, "com.amazonaws.cognitoidentityprovider#RespondToAuthChallenge": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#RespondToAuthChallengeRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#RespondToAuthChallengeResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#ExpiredCodeException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#MFAMethodNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordHistoryPolicyViolationException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFANotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Some API operations in a user pool generate a challenge, like a prompt for an MFA\n code, for device authentication that bypasses MFA, or for a custom authentication\n challenge. A RespondToAuthChallenge API request provides the answer to that\n challenge, like a code or a secure remote password (SRP). The parameters of a response\n to an authentication challenge vary with the type of challenge.
For more information about custom authentication challenges, see Custom\n authentication challenge Lambda triggers.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe ID of the app client where the user is signing in.
", "smithy.api#required": {} } }, "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "The name of the challenge that you are responding to.
\nYou can't respond to an ADMIN_NO_SRP_AUTH challenge with this\n operation.
Possible challenges include the following:
\nAll of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.
\n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.
\n PASSWORD: Respond with the user's password as PASSWORD.
\n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.
\n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.
\n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n
\n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n
\n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .
\n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.
\n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.
\n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.
\n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.
\n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.
\n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.
Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.
\nIn a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.
To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n
To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n
The session identifier that maintains the state of authentication requests and\n challenge responses. If an AdminInitiateAuth or\n AdminRespondToAuthChallenge API request results in a determination that\n your application must pass another challenge, Amazon Cognito returns a session with other\n challenge parameters. Send this session identifier, unmodified, to the next\n AdminRespondToAuthChallenge request.
The responses to the challenge that you received in the previous request. Each\n challenge has its own required response parameters. The following examples are partial\n JSON request bodies that highlight challenge-response parameters.
\nYou must provide a SECRET_HASH parameter in all challenge responses to an app\n client that has a client secret. Include a DEVICE_KEY for device\n authentication.
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"ANSWER\": \"[Challenge name]\"}\n
Available challenges are PASSWORD, PASSWORD_SRP, \n EMAIL_OTP, SMS_OTP, and WEB_AUTHN.
Complete authentication in the SELECT_CHALLENGE response for\n PASSWORD, PASSWORD_SRP, and WEB_AUTHN:
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"WEB_AUTHN\",\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD\",\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"PASSWORD_SRP\",\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n
For SMS_OTP and EMAIL_OTP, respond with the\n username and answer. Your user pool will send a code for the user to submit in\n the next challenge response.
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"SMS_OTP\",\n \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"SELECT_CHALLENGE\", \"ChallengeResponses\": {\n \"ANSWER\": \"EMAIL_OTP\",\n \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"WEB_AUTHN\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"CREDENTIAL\": \"[AuthenticationResponseJSON]\"}\n
\n \"ChallengeName\": \"PASSWORD\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"PASSWORD\": \"[password]\"}\n
\n \"ChallengeName\": \"PASSWORD_SRP\", \"ChallengeResponses\": {\n \"USERNAME\": \"[username]\",\n \"SRP_A\": \"[SRP_A]\"}\n
\n \"ChallengeName\": \"SMS_OTP\", \"ChallengeResponses\": \n {\"SMS_OTP_CODE\": \"[code]\", \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"EMAIL_OTP\", \"ChallengeResponses\": {\"EMAIL_OTP_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"SMS_MFA\", \"ChallengeResponses\": {\"SMS_MFA_CODE\":\n \"[code]\", \"USERNAME\": \"[username]\"}\n
This challenge response is part of the SRP flow. Amazon Cognito requires \n that your application respond to this challenge within a few seconds. When\n the response time exceeds this period, your user pool returns a\n NotAuthorizedException error.
\n \"ChallengeName\": \"PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"PASSWORD_CLAIM_SIGNATURE\": \"[claim_signature]\",\n \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\", \"TIMESTAMP\":\n [timestamp], \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"CUSTOM_CHALLENGE\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"ANSWER\": \"[challenge_answer]\"}\n
\n \"ChallengeName\": \"NEW_PASSWORD_REQUIRED\", \"ChallengeResponses\":\n {\"NEW_PASSWORD\": \"[new_password]\", \"USERNAME\":\n \"[username]\"}\n
To set any required attributes that InitiateAuth returned in\n an requiredAttributes parameter, add\n \"userAttributes.[attribute_name]\": \"[attribute_value]\".\n This parameter can also set values for writable attributes that aren't\n required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n \"ChallengeName\": \"SOFTWARE_TOKEN_MFA\", \"ChallengeResponses\":\n {\"USERNAME\": \"[username]\", \"SOFTWARE_TOKEN_MFA_CODE\":\n [authenticator_code]}\n
\n \"ChallengeName\": \"DEVICE_SRP_AUTH\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"DEVICE_KEY\": \"[device_key]\", \"SRP_A\":\n \"[srp_a]\"}\n
\n \"ChallengeName\": \"DEVICE_PASSWORD_VERIFIER\", \"ChallengeResponses\":\n {\"DEVICE_KEY\": \"[device_key]\", \"PASSWORD_CLAIM_SIGNATURE\":\n \"[claim_signature]\", \"PASSWORD_CLAIM_SECRET_BLOCK\": \"[secret_block]\",\n \"TIMESTAMP\": [timestamp], \"USERNAME\": \"[username]\"}\n
\n \"ChallengeName\": \"MFA_SETUP\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\"}, \"SESSION\": \"[Session ID from\n VerifySoftwareToken]\"\n
\n \"ChallengeName\": \"SELECT_MFA_TYPE\", \"ChallengeResponses\": {\"USERNAME\":\n \"[username]\", \"ANSWER\": \"[SMS_MFA|EMAIL_MFA|SOFTWARE_TOKEN_MFA]\"}\n
For more information about SECRET_HASH, see Computing secret hash values. For information about\n DEVICE_KEY, see Working with user devices in your user pool.
Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
The request to respond to an authentication challenge.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#RespondToAuthChallengeResponse": { "type": "structure", "members": { "ChallengeName": { "target": "com.amazonaws.cognitoidentityprovider#ChallengeNameType", "traits": { "smithy.api#documentation": "The name of the next challenge that you must respond to.
\nPossible challenges include the following:
\nAll of the following challenges require USERNAME and, when the app\n client has a client secret, SECRET_HASH in the parameters. Include a \n DEVICE_KEY for device authentication.
\n WEB_AUTHN: Respond to the challenge with the results of a\n successful authentication with a WebAuthn authenticator, or passkey, as \n CREDENTIAL. Examples of WebAuthn authenticators include \n biometric devices and security keys.
\n PASSWORD: Respond with the user's password as PASSWORD.
\n PASSWORD_SRP: Respond with the initial SRP secret as SRP_A.
\n SELECT_CHALLENGE: Respond with a challenge selection as ANSWER. \n It must be one of the challenge types in the AvailableChallenges response \n parameter. Add the parameters of the selected challenge, for example USERNAME\n and SMS_OTP.
\n SMS_MFA: Respond with the code that your user pool delivered in an SMS\n message, as SMS_MFA_CODE\n
\n EMAIL_MFA: Respond with the code that your user pool delivered in an email\n message, as EMAIL_MFA_CODE\n
\n EMAIL_OTP: Respond with the code that your user pool delivered in an email\n message, as EMAIL_OTP_CODE .
\n SMS_OTP: Respond with the code that your user pool delivered in an SMS\n message, as SMS_OTP_CODE.
\n PASSWORD_VERIFIER: Respond with the second stage of SRP secrets as\n PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, \n and TIMESTAMP.
\n CUSTOM_CHALLENGE: This is returned if your custom authentication\n flow determines that the user should pass another challenge before tokens are\n issued. The parameters of the challenge are determined by your Lambda function\n and issued in the ChallengeParameters of a challenge response.
\n DEVICE_SRP_AUTH: Respond with the initial parameters of device SRP \n authentication. For more information, see Signing in with a device.
\n DEVICE_PASSWORD_VERIFIER: Respond with\n PASSWORD_CLAIM_SIGNATURE,\n PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after\n client-side SRP calculations. For more information, see Signing in with a device.
\n NEW_PASSWORD_REQUIRED: For users who are required to change their\n passwords after successful first login. Respond to this challenge with \n NEW_PASSWORD and any required attributes that Amazon Cognito returned in \n the requiredAttributes parameter. You can also set values for \n attributes that aren't required by your user pool and that your app client \n can write.
Amazon Cognito only returns this challenge for users who have temporary passwords.\n When you create passwordless users, you must provide values for all required \n attributes.
\nIn a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value. \nIn AdminRespondToAuthChallenge or RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the \nrequiredAttributes parameter, then use the AdminUpdateUserAttributes or UpdateUserAttributes API \noperation to modify the value of any additional attributes.
\n MFA_SETUP: For users who are required to setup an MFA factor\n before they can sign in. The MFA types activated for the user pool will be\n listed in the challenge parameters MFAS_CAN_SETUP value.
To set up time-based one-time password (TOTP) MFA, use the session returned \n in this challenge from InitiateAuth or AdminInitiateAuth \n as an input to AssociateSoftwareToken. Then, use the session returned\n by VerifySoftwareToken as an input to \n RespondToAuthChallenge or AdminRespondToAuthChallenge\n with challenge name MFA_SETUP to complete sign-in.\n
To set up SMS or email MFA, collect a phone_number or \n email attribute for the user. Then restart the authentication \n flow with an InitiateAuth or AdminInitiateAuth request.\n
The session identifier that maintains the state of authentication requests and\n challenge responses. If an InitiateAuth or\n RespondToAuthChallenge API request results in a determination that your\n application must pass another challenge, Amazon Cognito returns a session with other challenge\n parameters. Send this session identifier, unmodified, to the next\n RespondToAuthChallenge request.
The parameters that define your response to the next challenge.
" } }, "AuthenticationResult": { "target": "com.amazonaws.cognitoidentityprovider#AuthenticationResultType", "traits": { "smithy.api#documentation": "The outcome of a successful authentication process. After your application has passed\n all challenges, Amazon Cognito returns an AuthenticationResult with the JSON web\n tokens (JWTs) that indicate successful sign-in.
This response parameter lists the available authentication challenges that users can\n select from in choice-based authentication. For example, they might be\n able to choose between passkey authentication, a one-time password from an SMS message,\n and a traditional password.
" } } }, "traits": { "smithy.api#documentation": "The response to respond to the authentication challenge.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#RestorationDescriptionType": { "type": "structure", "members": { "RestoreId": { "target": "com.amazonaws.cognitoidentityprovider#RestoreIdType", "traits": { "smithy.api#documentation": "The ID of the recovery.
" } }, "RestoreStatus": { "target": "com.amazonaws.cognitoidentityprovider#RestoreStatusType", "traits": { "smithy.api#documentation": "The status of the recovery. For a description of each status, see the\n RestoreStatus parameter of RestorationType.
The point in time that the recovery restores the user pool to.
" } } }, "traits": { "smithy.api#documentation": "A summary of a point-in-time recovery of a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#RestorationListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#RestorationDescriptionType" } }, "com.amazonaws.cognitoidentityprovider#RestorationType": { "type": "structure", "members": { "RestoreId": { "target": "com.amazonaws.cognitoidentityprovider#RestoreIdType", "traits": { "smithy.api#documentation": "The ID of the recovery. Use this ID in requests to describe, start, or cancel the\n recovery.
" } }, "RestoreStatus": { "target": "com.amazonaws.cognitoidentityprovider#RestoreStatusType", "traits": { "smithy.api#documentation": "The status of the recovery. Can be one of the following values.
\nAmazon Cognito is generating the recovery preview, which might not be available\n immediately. Write operations in the user pool are paused.
\nThe recovery preview is ready for review. Write operations in the user\n pool are paused. Within 24 hours after you initiate the recovery, apply\n it with a StartPointInTimeRecovery request or discard it with\n a CancelPointInTimeRecovery request.
You canceled the recovery. Amazon Cognito resumed write operations and\n didn't change your user pool data.
\nAmazon Cognito couldn't generate the recovery preview. Amazon Cognito resumed write\n operations and didn't change your user pool data. You can initiate a\n new recovery.
\nYou didn't start or cancel the recovery within 24 hours after you\n initiated it. Amazon Cognito resumed write operations and didn't change your\n user pool data.
\nAmazon Cognito is restoring user data in the user pool to its state at the\n recovery point. Write operations in the user pool are paused.
\nAmazon Cognito restored your user pool to its state at the recovery point and\n resumed write operations.
\nThe recovery encountered an internal error. Write operations in the user\n pool remain paused. Amazon Web Services Support contacts you through a support case to\n resolve the issue.
\nAmazon Cognito stopped the recovery because of an internal failure. Write\n operations in the user pool remain paused, and you can't cancel or\n retry the recovery. Amazon Web Services Support contacts you through a support case to\n resolve the issue.
\nThe point in time that the recovery restores the user pool to.
" } }, "TriggerTimestamp": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The end of the period of changes that the recovery reverts. This time is shortly\n after the time that you initiated the recovery. The recovery reverts changes to user\n data that occurred between RestoreTimestamp and\n TriggerTimestamp.
The recovery preview. For each type of entity, the preview shows the number of\n entities that the recovery creates, updates, and deletes. The preview doesn't\n include user data. Amazon Cognito returns the preview when it's available.
" } } }, "traits": { "smithy.api#documentation": "The details of a point-in-time recovery of a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#RestoreIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}$" } }, "com.amazonaws.cognitoidentityprovider#RestorePreviewListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#RestorePreviewType" } }, "com.amazonaws.cognitoidentityprovider#RestorePreviewType": { "type": "structure", "members": { "Entity": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The type of user pool entity that the recovery changes. Can be one of the following\n values.
\nUser profiles, including their attributes.
\nUser pool groups.
\nThe MFA settings of users.
\nThe passkeys that users registered.
\nThe number of entities of this type that the recovery creates. These entities\n existed at the recovery point and were deleted after it.
" } }, "UpdateCount": { "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of entities of this type that the recovery reverts to their state at the\n recovery point. These entities were modified after the recovery point.
" } }, "DeleteCount": { "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of entities of this type that the recovery deletes. These entities were\n created after the recovery point.
" } } }, "traits": { "smithy.api#documentation": "The number of entities of one type that a point-in-time recovery creates, updates,\n and deletes.
" } }, "com.amazonaws.cognitoidentityprovider#RestoreStatusType": { "type": "enum", "members": { "PREVIEW_GENERATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIEW_GENERATING" } }, "PREVIEW_GENERATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIEW_GENERATED" } }, "PREVIEW_CANCELLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIEW_CANCELLED" } }, "PREVIEW_GENERATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIEW_GENERATION_FAILED" } }, "PREVIEW_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIEW_EXPIRED" } }, "RESTORING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORING" } }, "RESTORE_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESTORE_COMPLETED" } }, "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEMPORARY_INTERNAL_ERROR_SEE_SUPPORT_CASE" } }, "AWS_ABORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_ABORTED" } } } }, "com.amazonaws.cognitoidentityprovider#RetryGracePeriodSecondsType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 60 } } }, "com.amazonaws.cognitoidentityprovider#RevokeAssociatedSessionsType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "LINKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINKED" } } }, "traits": { "smithy.api#documentation": "Controls whether revoking a session also revokes the sessions that are linked to it.\n NONE revokes only the targeted session. LINKED also revokes\n the directly linked session or sessions, interpreted relative to the type of the\n targeted session: revoking a token session also revokes the parent SSO session it came\n through, and revoking an SSO session also revokes the token sessions that came through\n it. The set of linked sessions is eventually consistent, so associated sessions are\n typically revoked within a few seconds.
Revokes all of the access tokens generated by, and at the same time as, the specified\n refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito\n user APIs, or to authorize access to your resource server.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe refresh token that you want to revoke.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client where the token that you want to revoke was issued.
", "smithy.api#required": {} } }, "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { "smithy.api#documentation": "The client secret of the requested app client, if the client has a secret.
" } }, "RevokeAssociatedSessions": { "target": "com.amazonaws.cognitoidentityprovider#RevokeAssociatedSessionsType", "traits": { "smithy.api#documentation": "Specifies whether to also revoke the SSO session that is linked to the token session\n being revoked. NONE, the default, revokes only the token session that is\n associated with the refresh token. LINKED also revokes the parent SSO\n session that the token session came through; the other token sessions that came through\n that SSO session aren't revoked. LINKED has no effect when session tracking\n is disabled or when the token session has no parent SSO session.
Revokes a specific session for the currently signed-in user. Amazon Cognito authorizes this\n operation with the user's access token, revokes all refresh and access tokens that are\n associated with the session, and deletes the session record. You can't revoke the\n session that the calling access token belongs to.
", "smithy.api#examples": [ { "title": "Example revoke one of a user's own sessions", "documentation": "The following example revokes a single token session that belongs to the user who owns the provided access token, such as signing out a lost or stolen device. Only the targeted session is revoked.", "input": { "AccessToken": "eyJra456defEXAMPLE", "SessionId": "tknm5k9p2q7r4s8t1v6w3x0y5z2b", "RevokeAssociatedSessions": "NONE" }, "output": {} } ], "smithy.api#optionalAuth": {} } }, "com.amazonaws.cognitoidentityprovider#RevokeUserSessionRequest": { "type": "structure", "members": { "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the user. Amazon Cognito uses this token to authorize\n the request and to identify the user.
", "smithy.api#required": {} } }, "SessionId": { "target": "com.amazonaws.cognitoidentityprovider#SessionIdType", "traits": { "smithy.api#documentation": "The ID of the session to revoke. This is a 28-character string of lowercase letters\n and digits, prefixed with tkn for a token session or sso for\n an SSO session. This value can't identify the caller's own current session.
Specifies whether to also revoke the sessions that are linked to the targeted session.\n NONE, the default, revokes only the targeted session. LINKED\n also revokes the directly linked session or sessions, interpreted relative to the type\n of the targeted session: revoking a token session also revokes the parent SSO session it\n came through, and revoking an SSO session also revokes the token sessions that came\n through it. The set of linked sessions is eventually consistent, so associated\n sessions are typically revoked within a few seconds.
The ID of the user pool that has the risk configuration applied.
" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The app client where this configuration is applied. When this parameter isn't present,\n the risk configuration applies to all user pool app clients that don't have\n client-level settings.
" } }, "CompromisedCredentialsRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#CompromisedCredentialsRiskConfigurationType", "traits": { "smithy.api#documentation": "Settings for compromised-credentials actions and authentication types with threat\n protection in full-function ENFORCED mode.
The settings for automated responses and notification templates for adaptive\n authentication with threat protection.
" } }, "RiskExceptionConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType", "traits": { "smithy.api#documentation": "Exceptions to the risk evaluation configuration, including always-allow and\n always-block IP address ranges.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The settings of risk configuration for threat protection with threat protection in a\n user pool.
" } }, "com.amazonaws.cognitoidentityprovider#RiskDecisionType": { "type": "enum", "members": { "NoRisk": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NoRisk" } }, "AccountTakeover": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AccountTakeover" } }, "Block": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Block" } } } }, "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType": { "type": "structure", "members": { "BlockedIPRangeList": { "target": "com.amazonaws.cognitoidentityprovider#BlockedIPRangeListType", "traits": { "smithy.api#documentation": "An always-block IP address list. Overrides the risk decision and always blocks\n authentication requests. This parameter is displayed and set in CIDR notation.
" } }, "SkippedIPRangeList": { "target": "com.amazonaws.cognitoidentityprovider#SkippedIPRangeListType", "traits": { "smithy.api#documentation": "An always-allow IP address list. Risk detection isn't performed on the IP addresses in\n this range list. This parameter is displayed and set in CIDR notation.
" } } }, "traits": { "smithy.api#documentation": "Exceptions to the risk evaluation configuration, including always-allow and\n always-block IP address ranges.
" } }, "com.amazonaws.cognitoidentityprovider#RiskLevelType": { "type": "enum", "members": { "Low": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Low" } }, "Medium": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Medium" } }, "High": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "High" } } } }, "com.amazonaws.cognitoidentityprovider#RoutingType": { "type": "structure", "members": { "Failover": { "target": "com.amazonaws.cognitoidentityprovider#FailoverType", "traits": { "smithy.api#documentation": "The failover configuration that specifies the secondary region and health check settings.
" } } }, "traits": { "smithy.api#documentation": "Specifies routing configuration for user pool domains. Contains failover settings for multi-region deployments.
" } }, "com.amazonaws.cognitoidentityprovider#S3ArnType": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 1024 }, "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:::[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?$" } }, "com.amazonaws.cognitoidentityprovider#S3BucketType": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 1024 }, "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*(?The ARN of an Amazon S3 bucket that's the destination for threat protection log\n export." } } }, "traits": { "smithy.api#documentation": "Configuration for the Amazon S3 bucket destination of user activity log export with threat\n protection.
" } }, "com.amazonaws.cognitoidentityprovider#SESConfigurationSet": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, "com.amazonaws.cognitoidentityprovider#SMSMfaSettingsType": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether SMS message MFA is activated. If an MFA type is activated for a\n user, the user will be prompted for MFA during all sign-in attempts, unless device\n tracking is turned on and the device has been trusted.
" } }, "PreferredMfa": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the\n specified user for a code delivered by SMS message after username-password sign-in\n succeeds.
" } } }, "traits": { "smithy.api#documentation": "A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS\n MFA on and off, and can set SMS as preferred when other MFA options are available. You\n can't turn off SMS MFA for any of your users when MFA is required in your user pool; you\n can only set the type that your user prefers.
" } }, "com.amazonaws.cognitoidentityprovider#SSOSessionMaxValidityMinutesType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 129600 } } }, "com.amazonaws.cognitoidentityprovider#SchemaAttributeType": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.cognitoidentityprovider#CustomAttributeNameType", "traits": { "smithy.api#documentation": "The name of your user pool attribute. When you create or update a user pool, adding a\n schema attribute creates a custom or developer-only attribute. When you add an attribute\n with a Name value of MyAttribute, Amazon Cognito creates the custom\n attribute custom:MyAttribute. When DeveloperOnlyAttribute is\n true, Amazon Cognito creates your attribute as dev:MyAttribute. In\n an operation that describes a user pool, Amazon Cognito returns this value as value\n for standard attributes, custom:value for custom attributes, and\n dev:value for developer-only attributes..
The data format of the values for your attribute. When you choose an\n AttributeDataType, Amazon Cognito validates the input against the data type. A\n custom attribute value in your user's ID token is always a string, for example\n \"custom:isMember\" : \"true\" or \"custom:YearsAsMember\" :\n \"12\".
You should use WriteAttributes in the user pool client to control how attributes can\n be mutated for new use cases instead of using\n DeveloperOnlyAttribute.
Specifies whether the attribute type is developer only. This attribute can only be\n modified by an administrator. Users won't be able to modify this attribute using their\n access token. For example, DeveloperOnlyAttribute can be modified using\n AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.
Specifies whether the value of the attribute can be changed.
\nAny user pool attribute whose value you map from an IdP attribute must be mutable,\n with a parameter value of true. Amazon Cognito updates mapped attributes when users\n sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws\n an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User\n Pool.
Specifies whether a user pool attribute is required. If the attribute is required and\n the user doesn't provide a value, registration or sign-in will fail.
" } }, "NumberAttributeConstraints": { "target": "com.amazonaws.cognitoidentityprovider#NumberAttributeConstraintsType", "traits": { "smithy.api#documentation": "Specifies the constraints for an attribute of the number type.
" } }, "StringAttributeConstraints": { "target": "com.amazonaws.cognitoidentityprovider#StringAttributeConstraintsType", "traits": { "smithy.api#documentation": "Specifies the constraints for an attribute of the string type.
" } } }, "traits": { "smithy.api#documentation": "A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.
Developer-only dev: attributes are a legacy feature of user pools, and\n are read-only to all app clients. You can create and update developer-only attributes\n only with IAM-authenticated API operations. Use app client read/write permissions\n instead.
This exception is thrown when the specified scope doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#ScopeListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#ScopeType" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.cognitoidentityprovider#ScopeType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$" } }, "com.amazonaws.cognitoidentityprovider#SearchPaginationTokenType": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.cognitoidentityprovider#SearchedAttributeNamesListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#AttributeNameType" } }, "com.amazonaws.cognitoidentityprovider#SecretCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 16 }, "smithy.api#pattern": "^[A-Za-z0-9]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#SecretHashType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=/]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#SecurityPolicyType": { "type": "enum", "members": { "TLS_V1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS_V1" } }, "TLS_V1_2_2021": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS_V1_2_2021" } }, "TLS_V1_3_2025": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TLS_V1_3_2025" } } } }, "com.amazonaws.cognitoidentityprovider#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "The request exceeded your account's service quota. To increase your limit, use or submit a Service Quotas increase request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#SessionDescriptionType": { "type": "structure", "members": { "SessionId": { "target": "com.amazonaws.cognitoidentityprovider#SessionIdType", "traits": { "smithy.api#documentation": "The unique identifier for the session. This is a 28-character string of lowercase\n letters and digits, prefixed with tkn for a token session or\n sso for an SSO session.
The type of the session. Valid values are TOKEN and\n SSO.
The ID of the app client that the session belongs to.
" } }, "CreateDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the session was created.
" } }, "LastActiveDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time of the most recent activity on the session. For a token session,\n this is the most recent token refresh or rotation; a new authentication creates a new\n token session rather than updating an existing one. For an SSO session, this is the most\n recent authentication, token grant, or token rotation.
" } }, "DeviceType": { "target": "com.amazonaws.cognitoidentityprovider#SessionDeviceType", "traits": { "smithy.api#documentation": "A description of the device associated with the most recent activity on the session,\n derived from the parsed user agent (operating system and browser or app). Amazon Cognito\n overwrites this value on each sign-in, refresh, and rotation. The value can be\n unknown. The maximum length is 1,024 characters.
The IP address associated with the most recent activity on the session. Amazon Cognito\n overwrites this value on each refresh and rotation. The maximum length is 128\n characters.
" } }, "LastLocation": { "target": "com.amazonaws.cognitoidentityprovider#SessionLocationType", "traits": { "smithy.api#documentation": "The geographic location of the most recent activity on the session, derived from the\n IP address.
" } }, "OriginSessionId": { "target": "com.amazonaws.cognitoidentityprovider#SessionIdType", "traits": { "smithy.api#documentation": "For a token session, the ID of the SSO session that the token session originated from.\n This value is null for sessions that were initiated through the API and didn't come\n through an SSO session. Amazon Cognito returns this value for token sessions only.
" } }, "IsCurrentSession": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "Specifies whether this session matches the access token supplied in the request. This\n value is always false for the AdminListUserSessions operation,\n which doesn't take an access token.
Describes an active user session. Amazon Cognito returns this type in the responses of\n ListUserSessions and AdminListUserSessions, for both token\n sessions and SSO sessions.
The city of the most recent activity on the session, derived from the IP address. This\n value can be null if geo-IP resolution fails. The maximum length is 256\n characters.
" } }, "Country": { "target": "com.amazonaws.cognitoidentityprovider#SessionLocationCountryType", "traits": { "smithy.api#documentation": "The country of the most recent activity on the session, derived from the IP address\n and returned in English (for example, United States). This is a country\n name as returned by the geo-IP database, not an ISO country code, and can be\n unknown if geo-IP resolution fails.
The geographic location of the most recent activity on a session, derived from the IP\n address.
" } }, "com.amazonaws.cognitoidentityprovider#SessionType": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 4096 }, "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#SessionTypeType": { "type": "enum", "members": { "TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TOKEN" } }, "SSO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SSO" } } }, "traits": { "smithy.api#documentation": "The type of a user session. TOKEN identifies a token session, which\n represents an app's authenticated session for a user and is tied to a refresh token.\n SSO identifies an SSO session, which is a single sign-on (SSO) session that\n records an authentication through managed login and can let the user sign in to other\n apps without re-authenticating.
Sets up or modifies the logging configuration of a user pool. User pools can export\n user notification logs and, when threat protection is active, user-activity logs. For\n more information, see Exporting user\n pool logs.
" } }, "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool where you want to configure logging.
", "smithy.api#required": {} } }, "LogConfigurations": { "target": "com.amazonaws.cognitoidentityprovider#LogConfigurationListType", "traits": { "smithy.api#documentation": "A collection of the logging configurations for a user pool.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetLogDeliveryConfigurationResponse": { "type": "structure", "members": { "LogDeliveryConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType", "traits": { "smithy.api#documentation": "The logging configuration that you applied to the requested user pool.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetRiskConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SetRiskConfigurationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SetRiskConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnNotEnabledException" } ], "traits": { "smithy.api#documentation": "Configures threat protection for a user pool or app client. Sets configuration for the\n following.
\nResponses to risks with adaptive authentication
\nResponses to vulnerable passwords with compromised-credentials\n detection
\nNotifications to users who have had risky activity detected
\nIP-address denylist and allowlist
\nTo set the risk configuration for the user pool to defaults, send this request with\n only the UserPoolId parameter. To reset the threat protection settings of\n an app client to be inherited from the user pool, send UserPoolId and\n ClientId parameters only. To change threat protection to audit-only or\n off, update the value of UserPoolAddOns in an UpdateUserPool\n request. To activate this setting, your user pool must be on the \n Plus tier.
In secondary regions for user pools with multi-region replication, only the\n SourceARN and From attributes of\n NotifyConfiguration can be modified to configure region-specific SES\n integration. All other risk configuration settings must match the existing values to\n maintain consistency across replicas.
The ID of the user pool where you want to set a risk configuration. If you include\n UserPoolId in your request, don't include ClientId.\n When the client ID is null, the same risk configuration is applied to all the clients in\n the userPool. When you include both ClientId and UserPoolId,\n Amazon Cognito maps the configuration to the app client only.
The ID of the app client where you want to set a risk configuration. If\n ClientId is null, then the risk configuration is mapped to\n UserPoolId. When the client ID is null, the same risk configuration is\n applied to all the clients in the userPool.
When you include a ClientId parameter, Amazon Cognito maps the configuration to\n the app client. When you include both ClientId and UserPoolId,\n Amazon Cognito maps the configuration to the app client only.
The configuration of automated reactions to detected compromised credentials. Includes\n settings for blocking future sign-in requests and for the types of password-submission\n events you want to monitor.
" } }, "AccountTakeoverRiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AccountTakeoverRiskConfigurationType", "traits": { "smithy.api#documentation": "The settings for automated responses and notification templates for adaptive\n authentication with threat protection.
" } }, "RiskExceptionConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#RiskExceptionConfigurationType", "traits": { "smithy.api#documentation": "A set of IP-address overrides to threat protection. You can set up IP-address\n always-block and always-allow lists.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetRiskConfigurationResponse": { "type": "structure", "members": { "RiskConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#RiskConfigurationType", "traits": { "smithy.api#documentation": "The API response that contains the risk configuration that you set and the timestamp\n of the most recent change.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetUICustomization": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SetUICustomizationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SetUICustomizationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Configures UI branding settings for domains with the hosted UI (classic) branding\n version. Your user pool must have a domain. Configure a domain with .
\nSet the default configuration for all clients with a ClientId of\n ALL. When the ClientId value is an app client ID, the\n settings you pass in this request apply to that app client and override the default\n ALL configuration.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to apply branding to the classic hosted\n UI.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to customize. To apply a default style to all\n app clients not configured with client-level branding, set this parameter value to\n ALL.
A plaintext CSS file that contains the custom fields that you want to apply to your\n user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to\n your user pool App clients tab, select Login\n pages, edit Hosted UI (classic) style, and select\n the link to CSS template.css.
The image that you want to set as your login in the classic hosted UI, as a\n Base64-formatted binary object.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetUICustomizationResponse": { "type": "structure", "members": { "UICustomization": { "target": "com.amazonaws.cognitoidentityprovider#UICustomizationType", "traits": { "smithy.api#documentation": "Information about the hosted UI branding that you applied.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserMFAPreference": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SetUserMFAPreferenceRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SetUserMFAPreferenceResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Set the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nUser preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as\n the preferred MFA method when multiple methods are available.
" } }, "SoftwareTokenMfaSettings": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType", "traits": { "smithy.api#documentation": "User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates\n TOTP MFA and sets it as the preferred MFA method when multiple methods are available.\n Users must register a TOTP authenticator before they set this as their preferred MFA\n method.
" } }, "EmailMfaSettings": { "target": "com.amazonaws.cognitoidentityprovider#EmailMfaSettingsType", "traits": { "smithy.api#documentation": "User preferences for email message MFA. Activates or deactivates email MFA and sets it\n as the preferred MFA method when multiple methods are available.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "WebAuthnMfaSettings": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnMfaSettingsType", "traits": { "smithy.api#documentation": "User preferences for passkey MFA. Activates or deactivates passkey MFA for the user.\n When activated, passkey authentication requires user verification, and passkey sign-in\n is available when MFA is required. To activate this setting, the\n FactorConfiguration of your user pool WebAuthnConfiguration\n must be MULTI_FACTOR_WITH_USER_VERIFICATION.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
Sets the session configuration for a user pool app client. The configurable\n client-level setting is the maximum validity period for silent reuse of an SSO session.\n This operation performs a full replacement of the client-level session configuration;\n every request parameter is required, and session tracking must be enabled for the user\n pool. The user pool must be in the Essentials or Plus tier. Otherwise, this operation\n returns a FeatureUnavailableInTierException.
The ID of the user pool that contains the app client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to configure.
", "smithy.api#required": {} } }, "SSOSession": { "target": "com.amazonaws.cognitoidentityprovider#ClientSSOSessionConfigType", "traits": { "smithy.api#documentation": "The SSO session settings for the app client.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolClientSessionConfigurationResponse": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the app client.
" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that the session configuration was applied to.
" } }, "SSOSession": { "target": "com.amazonaws.cognitoidentityprovider#ClientSSOSessionConfigType", "traits": { "smithy.api#documentation": "The SSO session settings that were applied to the app client.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfig": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Sets user pool multi-factor authentication (MFA) and passkey configuration. For more\n information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThe user pool ID.
", "smithy.api#required": {} } }, "SmsMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", "traits": { "smithy.api#documentation": "Configures user pool SMS messages for MFA. Sets the message template and the SMS\n message sending configuration for Amazon SNS.
" } }, "SoftwareTokenMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType", "traits": { "smithy.api#documentation": "Configures a user pool for time-based one-time password (TOTP) MFA. Enables or\n disables TOTP.
" } }, "EmailMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailMfaConfigType", "traits": { "smithy.api#documentation": "Sets configuration for user pool email message MFA and sign-in with one-time passwords\n (OTPs). Includes the subject and body of the email message template for sign-in and MFA\n messages. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { "smithy.api#documentation": "Sets multi-factor authentication (MFA) to be on, off, or optional. When\n ON, all users must set up MFA before they can sign in. When\n OPTIONAL, your application must make a client-side determination of\n whether a user wants to register an MFA device. For user pools with adaptive\n authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login\n doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in\n API responses and in managed login for users who have chosen and configured a preferred\n MFA factor.
The configuration of your user pool for passkey, or WebAuthn, authentication and\n registration. Includes relying-party configuration, user-verification requirements,\n and whether passkeys can satisfy MFA requirements.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolMfaConfigResponse": { "type": "structure", "members": { "SmsMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType", "traits": { "smithy.api#documentation": "Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs.\n Includes the message template and the SMS message sending configuration for\n Amazon SNS.
" } }, "SoftwareTokenMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType", "traits": { "smithy.api#documentation": "Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes\n TOTP enabled or disabled state.
" } }, "EmailMfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailMfaConfigType", "traits": { "smithy.api#documentation": "Shows configuration for user pool email message MFA and sign-in with one-time\n passwords (OTPs). Includes the subject and body of the email message template for\n sign-in and MFA messages. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "MfaConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolMfaType", "traits": { "smithy.api#documentation": "Displays multi-factor authentication (MFA) as on, off, or optional. When\n ON, all users must set up MFA before they can sign in. When\n OPTIONAL, your application must make a client-side determination of\n whether a user wants to register an MFA device. For user pools with adaptive\n authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login\n doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in\n API responses and in managed login for users who have chosen and configured a preferred\n MFA factor.
The configuration of your user pool for passkey, or WebAuthn, sign-in with\n authenticators such as biometric and security-key devices. Includes relying-party\n configuration and settings for user-verification requirements.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolSessionConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolSessionConfigurationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SetUserPoolSessionConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Enables or disables session tracking for a user pool, and sets the pool-wide maximum\n number of active token sessions that each user can have. This operation performs a\n full replacement of the pool-level session configuration; every request parameter is\n required. The user pool must be in the Essentials or Plus tier. Otherwise, this\n operation returns a FeatureUnavailableInTierException.
The ID of the user pool where you want to configure session tracking.
", "smithy.api#required": {} } }, "UserSessionTracking": { "target": "com.amazonaws.cognitoidentityprovider#UserSessionTrackingType", "traits": { "smithy.api#documentation": "Specifies whether Amazon Cognito tracks sessions for users in the user pool. Set this value to\n ENABLED to turn on server-side session tracking, or DISABLED\n to turn it off. When you set this value to DISABLED while the user pool\n remains active, existing client-level session configurations are retained but dormant,\n and are reactivated when you enable tracking again.
The pool-wide token session settings to apply.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserPoolSessionConfigurationResponse": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that the session configuration was applied to.
" } }, "UserSessionTracking": { "target": "com.amazonaws.cognitoidentityprovider#UserSessionTrackingType", "traits": { "smithy.api#documentation": "The session tracking setting that was applied to the user pool.
" } }, "TokenSession": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTokenSessionConfigType", "traits": { "smithy.api#documentation": "The pool-wide token session settings that were applied.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserSettings": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SetUserSettingsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SetUserSettingsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "\n This action is no longer supported. You can use it to configure\n only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software\n token or email MFA.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
You can use this parameter only to set an SMS configuration that uses SMS for\n delivery.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to set user settings.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SetUserSettingsResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response from the server for a set user settings request.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SignInPolicyType": { "type": "structure", "members": { "AllowedFirstAuthFactors": { "target": "com.amazonaws.cognitoidentityprovider#AllowedFirstAuthFactorsListType", "traits": { "smithy.api#documentation": "The sign-in methods that a user pool supports as the first factor. You can permit\n users to start authentication with a standard username and password, or with other\n one-time password and hardware factors.
\n\n SOFTWARE_TOKEN is not currently supported as a first auth factor.\n Do not include this value in AllowedFirstAuthFactors.
The policy for allowed types of authentication in a user pool.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "com.amazonaws.cognitoidentityprovider#SignUp": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#SignUpRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#SignUpResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidPasswordException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UsernameExistsException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Registers a user with an app client and requests a user name, password, and user\n attributes in the user pool.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nYou might receive a LimitExceeded exception in response to this request\n if you have exceeded a rate quota for email or SMS messages, and if your user pool\n automatically verifies email addresses or phone numbers. When you get this exception in\n the response, the user is successfully created and is in an UNCONFIRMED\n state.
The ID of the app client where the user wants to sign up.
", "smithy.api#required": {} } }, "SecretHash": { "target": "com.amazonaws.cognitoidentityprovider#SecretHashType", "traits": { "smithy.api#documentation": "A keyed-hash message authentication code (HMAC) calculated using the secret key of a\n user pool client and username plus the client ID in the message. For more information\n about SecretHash, see Computing secret hash values.
The username of the user that you want to sign up. The value of this parameter is\n typically a username, but can be any alias attribute in your user pool.
", "smithy.api#required": {} } }, "Password": { "target": "com.amazonaws.cognitoidentityprovider#PasswordType", "traits": { "smithy.api#documentation": "The user's proposed password. The password must comply with the password requirements of your user pool.
\nUsers can sign up without a password when your user pool supports passwordless sign-in\n with email or SMS OTPs. To create a user with no password, omit this parameter or submit\n a blank value. You can only create a passwordless user when passwordless sign-in is\n available.
" } }, "UserAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { "smithy.api#documentation": "An array of name-value pairs representing user attributes.
\nFor custom attributes, include a custom: prefix in the attribute name,\n for example custom:department.
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda\n trigger. This set of key-value pairs are for custom validation of information that you \n collect from your users but don't need to retain.
\nYour Lambda function can analyze this additional data and act on it. Your function\n can automatically confirm and verify select users or perform external API operations \n like logging user attributes and validation data to Amazon CloudWatch Logs.
\nFor more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
" } }, "AnalyticsMetadata": { "target": "com.amazonaws.cognitoidentityprovider#AnalyticsMetadataType", "traits": { "smithy.api#documentation": "Information that supports analytics outcomes with Amazon Pinpoint, including the \nuser's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, \nemail address, or phone number.
" } }, "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { "smithy.api#documentation": "Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat \nprotection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.
\nFor more information, see Collecting data for threat protection in\napplications.
" } }, "ClientMetadata": { "target": "com.amazonaws.cognitoidentityprovider#ClientMetadataType", "traits": { "smithy.api#documentation": "A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to register a user.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#SignUpResponse": { "type": "structure", "members": { "UserConfirmed": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the user was automatically confirmed. You can auto-confirm users\n with a pre sign-up Lambda trigger.
", "smithy.api#required": {} } }, "CodeDeliveryDetails": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsType", "traits": { "smithy.api#documentation": "In user pools that automatically verify and confirm new users, Amazon Cognito sends users a\n message with a code or link that confirms ownership of the phone number or email address\n that they entered. The CodeDeliveryDetails object is information about the\n delivery destination for that link or code.
The unique identifier of the new user, for example\n a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
A session Id that you can pass to ConfirmSignUp when you want to\n immediately sign in your user with the USER_AUTH flow after they complete\n sign-up.
The response from the server for a registration request.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#SkippedIPRangeListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#StringType" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.cognitoidentityprovider#SmsConfigurationType": { "type": "structure", "members": { "SnsCallerArn": { "target": "com.amazonaws.cognitoidentityprovider#OptionalArnType", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS caller. This is the ARN of the IAM role\n in your Amazon Web Services account that Amazon Cognito will use to send SMS messages. SMS\n messages are subject to a spending limit.
" } }, "ExternalId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The external ID provides additional security for your IAM role. You can use an\n ExternalId with the IAM role that you use with Amazon SNS to send SMS\n messages for your user pool. If you provide an ExternalId, your Amazon Cognito user\n pool includes it in the request to assume your IAM role. You can configure the role\n trust policy to require that Amazon Cognito, and any principal, provide the\n ExternalID. If you use the Amazon Cognito Management Console to create a role\n for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required\n permissions and a trust policy that demonstrates use of the\n ExternalId.
For more information about the ExternalId of a role, see How to use an\n external ID when granting access to your Amazon Web Services resources to a third\n party.
The Amazon Web Services Region to use with Amazon SNS integration. You can choose the same Region as your\n user pool, or a supported Legacy Amazon SNS alternate\n Region.
\n\n Amazon Cognito resources in the Asia Pacific (Seoul) Amazon Web Services Region must use your Amazon SNS\n configuration in the Asia Pacific (Tokyo) Region. For more information, see SMS message settings for Amazon Cognito user pools.
" } }, "EumsSms": { "target": "com.amazonaws.cognitoidentityprovider#EumsSmsConfigurationType", "traits": { "smithy.api#documentation": "The configuration for sending SMS messages through Amazon Web Services End User Messaging SMS, as\n an alternative to Amazon SNS. In a user pool, provide either the Amazon SNS configuration\n (SnsCallerArn) or this configuration, but not both. In Amazon Web Services Regions\n where Amazon SNS is not available, this configuration is required.
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.
" } }, "com.amazonaws.cognitoidentityprovider#SmsInviteMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 140 }, "smithy.api#pattern": "^(?s)" } }, "com.amazonaws.cognitoidentityprovider#SmsMfaConfigType": { "type": "structure", "members": { "SmsAuthenticationMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { "smithy.api#documentation": "The SMS authentication message that will be sent to users with the code they must sign\n in with. The message must contain the {####} placeholder. Your user pool\n replaces the placeholder with the MFA code. If this parameter isn't provided, your user\n pool sends a default message.
User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.
\nYou can set SmsConfiguration in CreateUserPool and \n UpdateUserPool, or in SetUserPoolMfaConfig.
The configuration of multi-factor authentication (MFA) with SMS messages in a user\n pool.
" } }, "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 140 }, "smithy.api#pattern": "\\{####\\}" } }, "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFANotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the software token time-based one-time password (TOTP)\n multi-factor authentication (MFA) isn't activated for the user pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFAUserCodeType": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 6 }, "smithy.api#pattern": "^[0-9]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaConfigType": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "The activation state of TOTP MFA.
" } } }, "traits": { "smithy.api#documentation": "Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in\n a user pool. Enables and disables availability of this feature.
" } }, "com.amazonaws.cognitoidentityprovider#SoftwareTokenMfaSettingsType": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether software token MFA is activated. If an MFA type is activated for a\n user, the user will be prompted for MFA during all sign-in attempts, unless device\n tracking is turned on and the device has been trusted.
" } }, "PreferredMfa": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether software token MFA is the preferred MFA method.
" } } }, "traits": { "smithy.api#documentation": "A user's preference for using time-based one-time password (TOTP) multi-factor\n authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when\n other MFA options are available. You can't turn off TOTP MFA for any of your users when\n MFA is required in your user pool; you can only set the type that your user prefers.
" } }, "com.amazonaws.cognitoidentityprovider#StartPointInTimeRecovery": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#StartPointInTimeRecoveryRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#StartPointInTimeRecoveryResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Applies a point-in-time recovery to a user pool. Before you start a recovery, review\n the recovery preview in the response to a request. You can start a recovery when\n its status is PREVIEW_GENERATED.
When you start a recovery, Amazon Cognito sets its status to RESTORING and\n restores user data in the user pool to its state at the recovery point. Write\n operations in the user pool remain paused until the recovery is complete. Sign-in and\n read operations continue to work. When the status of the recovery changes to\n RESTORE_COMPLETED, Amazon Cognito resumes write operations.
You can't cancel a recovery after you start it.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the recovery that you want to start.
", "smithy.api#required": {} } }, "RestoreId": { "target": "com.amazonaws.cognitoidentityprovider#RestoreIdType", "traits": { "smithy.api#documentation": "The ID of the recovery that you want to start. Amazon Cognito returns this ID in the response\n to an InitiatePointInTimeRecovery request.
The details of the recovery that you started, including its status.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#StartUserImportJob": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#StartUserImportJobRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#StartUserImportJobResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PreconditionNotMetException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Instructs your user pool to start importing users from a CSV file that contains their\n usernames and attributes. For more information about importing users from a CSV file,\n see Importing users from a CSV file.
" } }, "com.amazonaws.cognitoidentityprovider#StartUserImportJobRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that you want to start importing users into.
", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { "smithy.api#documentation": "The ID of a user import job that you previously created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to start the user import job.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#StartUserImportJobResponse": { "type": "structure", "members": { "UserImportJob": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType", "traits": { "smithy.api#documentation": "The details of the user import job. Includes logging destination, status, and the Amazon S3\n pre-signed URL for CSV upload.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to start the user import\n job.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistration": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistrationRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#StartWebAuthnRegistrationResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#LimitExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationMissingException" }, { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnNotEnabledException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Requests credential creation options from your user pool for the currently signed-in\n user. Returns information about the user pool, the user profile, and authentication\n requirements. Users must provide this information in their request to enroll your\n application with their passkey provider.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The information that a user can provide in their request to register with their\n passkey provider.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#StatusType": { "type": "enum", "members": { "Enabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "Disabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } } } }, "com.amazonaws.cognitoidentityprovider#StopUserImportJob": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#StopUserImportJobRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#StopUserImportJobResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PreconditionNotMetException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Instructs your user pool to stop a running job that's importing users from a CSV\n file that contains their usernames and attributes. For more information about importing\n users from a CSV file, see Importing users from a CSV file.
" } }, "com.amazonaws.cognitoidentityprovider#StopUserImportJobRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that you want to stop.
", "smithy.api#required": {} } }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { "smithy.api#documentation": "The ID of a running user import job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to stop the user import job.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#StopUserImportJobResponse": { "type": "structure", "members": { "UserImportJob": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType", "traits": { "smithy.api#documentation": "The details of the user import job. Includes logging destination, status, and the Amazon S3\n pre-signed URL for CSV upload.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to stop the user import\n job.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#StringAttributeConstraintsType": { "type": "structure", "members": { "MinLength": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The minimum length of a string attribute value.
" } }, "MaxLength": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The maximum length of a string attribute value. Must be a number less than or equal to\n 2^1023, represented as a string with a length of 131072 characters or\n fewer.
The minimum and maximum length values of an attribute that is of the string type, for\n example custom:department.
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to\n categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.
\nEach tag consists of a key and value, both of which you define. A key is a general\n category for more specific values. For example, if you have two versions of a user pool,\n one for testing and another for production, you might assign an Environment\n tag key to both user pools. The value of this key might be Test for one\n user pool, and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so\n that they appear on the Billing and Cost Management console, where you can track the\n costs associated with your user pools. In an Identity and Access Management policy, you can constrain\n permissions for user pools based on specific tags or tag values.
\nYou can use this action up to 5 times per second, per account. A user pool can have as\n many as 50 tags.
" } }, "com.amazonaws.cognitoidentityprovider#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user pool to assign the tags to.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { "smithy.api#documentation": "An array of tag keys and values that you want to assign to the user pool.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#TagValueType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.cognitoidentityprovider#TemporaryPasswordValidityDaysType": { "type": "integer", "traits": { "smithy.api#default": 0, "smithy.api#range": { "min": 0, "max": 365 } } }, "com.amazonaws.cognitoidentityprovider#TermsDescriptionListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#TermsDescriptionType" } }, "com.amazonaws.cognitoidentityprovider#TermsDescriptionType": { "type": "structure", "members": { "TermsId": { "target": "com.amazonaws.cognitoidentityprovider#TermsIdType", "traits": { "smithy.api#documentation": "The ID of the requested terms documents.
", "smithy.api#required": {} } }, "TermsName": { "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", "traits": { "smithy.api#documentation": "The type and friendly name of the requested terms documents.
", "smithy.api#required": {} } }, "Enforcement": { "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", "traits": { "smithy.api#documentation": "This parameter is reserved for future use and currently accepts one value.
", "smithy.api#required": {} } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The details of a set of terms documents. For more information, see Terms documents.
" } }, "com.amazonaws.cognitoidentityprovider#TermsEnforcementType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.cognitoidentityprovider#TermsExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "Terms document names must be unique to the app client. This exception is thrown when\n you attempt to create terms documents with a duplicate TermsName.
The ID of the terms documents.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the terms documents.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that the terms documents are assigned to.
", "smithy.api#required": {} } }, "TermsName": { "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", "traits": { "smithy.api#documentation": "The type and friendly name of the terms documents.
", "smithy.api#required": {} } }, "TermsSource": { "target": "com.amazonaws.cognitoidentityprovider#TermsSourceType", "traits": { "smithy.api#documentation": "This parameter is reserved for future use and currently accepts one value.
", "smithy.api#required": {} } }, "Enforcement": { "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", "traits": { "smithy.api#documentation": "This parameter is reserved for future use and currently accepts one value.
", "smithy.api#required": {} } }, "Links": { "target": "com.amazonaws.cognitoidentityprovider#LinksType", "traits": { "smithy.api#documentation": "A map of URLs to languages. For each localized language that will view the requested\n TermsName, assign a URL. A selection of cognito:default\n displays for all languages that don't have a language-specific URL.
For example, \"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n \"https://terms.example.com/es\".
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The details of a set of terms documents. For more information, see Terms documents.
" } }, "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when you've attempted to change your feature plan but\n the operation isn't permitted.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.cognitoidentityprovider#TimeUnitsType": { "type": "enum", "members": { "SECONDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "seconds" } }, "MINUTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "minutes" } }, "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "hours" } }, "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "days" } } } }, "com.amazonaws.cognitoidentityprovider#TokenModelType": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z0-9-_=.]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#TokenTypeIdentifierType": { "type": "enum", "members": { "ACCESS_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_TOKEN" } }, "ID_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ID_TOKEN" } }, "SAML2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAML2" } } } }, "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType": { "type": "structure", "members": { "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { "smithy.api#documentation": " A time unit for the value that you set in the AccessTokenValidity\n parameter. The default AccessTokenValidity time unit is hours.\n AccessTokenValidity duration can range from five minutes to one\n day.
A time unit for the value that you set in the IdTokenValidity parameter.\n The default IdTokenValidity time unit is hours.\n IdTokenValidity duration can range from five minutes to one day.
A time unit for the value that you set in the RefreshTokenValidity\n parameter. The default RefreshTokenValidity time unit is days.\n RefreshTokenValidity duration can range from 60 minutes to 10\n years.
The time units that, with IdTokenValidity,\n AccessTokenValidity, and RefreshTokenValidity, set and\n display the duration of ID, access, and refresh tokens for an app client. You can assign\n a separate token validity unit to each type of token.
The message returned when Amazon Cognito returns a TooManyFailedAttempts\n exception.
This exception is thrown when the user has made too many failed attempts for a given\n action, such as sign-in.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#TooManyRequestsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a too many requests\n exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the user has made too many requests for a given\n operation.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.cognitoidentityprovider#UICustomizationType": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool with hosted UI customizations.
" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The app client ID for your UI customization. When this value isn't present, the\n customization applies to all user pool app clients that don't have client-level\n settings..
" } }, "ImageUrl": { "target": "com.amazonaws.cognitoidentityprovider#ImageUrlType", "traits": { "smithy.api#documentation": "A URL path to the hosted logo image of your UI customization.
" } }, "CSS": { "target": "com.amazonaws.cognitoidentityprovider#CSSType", "traits": { "smithy.api#documentation": "The CSS values in the UI customization.
" } }, "CSSVersion": { "target": "com.amazonaws.cognitoidentityprovider#CSSVersionType", "traits": { "smithy.api#documentation": "The CSS version number.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A container for the UI customization information for the hosted UI in a user\n pool.
" } }, "com.amazonaws.cognitoidentityprovider#URLPatternListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#URLPatternType" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.cognitoidentityprovider#URLPatternType": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 256 }, "smithy.api#pattern": "^https://[!$-;=@-\\[\\]_a-z~]+$" } }, "com.amazonaws.cognitoidentityprovider#UnauthorizedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "Exception that is thrown when the request isn't authorized. This can happen due to an\n invalid access token in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when Amazon Cognito returns an unexpected Lambda exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters an unexpected exception with\n Lambda.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UnsupportedIdentityProviderException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the specified identifier isn't supported.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UnsupportedOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "Exception that is thrown when you attempt to perform an operation that isn't enabled\n for the user pool client.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UnsupportedTokenTypeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "Exception that is thrown when an unsupported token is passed to an operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UnsupportedUserStateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the user is in an unsupported state.
" } } }, "traits": { "smithy.api#documentation": "The request failed because the user is in an unsupported state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UntagResourceRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given tag IDs that you previously assigned to a user pool, removes them.
" } }, "com.amazonaws.cognitoidentityprovider#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsListType", "traits": { "smithy.api#documentation": "An array of tag keys that you want to remove from the user pool.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedback": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedbackRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateAuthEventFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnNotEnabledException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Provides the feedback for an authentication event generated by threat protection\n features. The user's response indicates that you think that the event either was from a\n valid user or was an unwanted authentication attempt. This feedback improves the risk\n evaluation decision for the user pool as part of Amazon Cognito threat protection.\n To activate this setting, your user pool must be on the \n Plus tier.
\nThis operation requires a FeedbackToken that Amazon Cognito generates and adds to\n notification emails when users have potentially suspicious authentication events. Users\n invoke this operation when they select the link that corresponds to\n {one-click-link-valid} or {one-click-link-invalid} in your\n notification template. Because FeedbackToken is a required parameter, you\n can't make requests to UpdateAuthEventFeedback without the contents of\n the notification email message.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThe ID of the user pool where you want to update auth event feedback.
", "smithy.api#required": {} } }, "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The name of the user that you want to query or modify. The value of this parameter\n is typically your user's username, but it can be any of their alias attributes. If\n username isn't an alias attribute in your user pool, this value\n must be the sub of a local user or the username of a user from a\n third-party IdP.
The ID of the authentication event that you want to submit feedback for.
", "smithy.api#required": {} } }, "FeedbackToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in\n the notification email message from the event.
", "smithy.api#required": {} } }, "FeedbackValue": { "target": "com.amazonaws.cognitoidentityprovider#FeedbackValueType", "traits": { "smithy.api#documentation": "Your feedback to the authentication event. When you provide a FeedbackValue\nvalue of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito\nhas evaluated some level of risk. When you provide a FeedbackValue value of\ninvalid, you tell Amazon Cognito that you don't trust a user session, or you \ndon't believe that Amazon Cognito evaluated a high-enough risk level.
Updates the configuration of a Client ID Metadata Document (CIMD) policy.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the CIMD policy.
", "smithy.api#required": {} } }, "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy that you want to update.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to associate with the CIMD policy.
", "smithy.api#required": {} } }, "PolicyName": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyNameType", "traits": { "smithy.api#documentation": "A friendly name for the CIMD policy.
" } }, "CacheDuration": { "target": "com.amazonaws.cognitoidentityprovider#CacheDurationType", "traits": { "smithy.api#documentation": "The length of time, in seconds, that Amazon Cognito caches a client metadata document\n that it retrieved from a URL that matches the policy. The value must be between 86,400\n seconds (one day) and 31,556,952 seconds (one year).
" } }, "URLPatterns": { "target": "com.amazonaws.cognitoidentityprovider#URLPatternListType", "traits": { "smithy.api#documentation": "One to five HTTPS URL patterns. Amazon Cognito accepts a client ID metadata document\n URL only when it matches one of these patterns. Patterns can contain the *\n wildcard character.
The updated CIMD policy.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateClientMetadataURLState": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateClientMetadataURLStateRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateClientMetadataURLStateResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CachedCIMDURLDoesNotExistException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Changes the cache state of a client metadata document URL for a client ID metadata\n document (CIMD) policy. Refresh a URL to make Amazon Cognito retrieve the client\n metadata document again, or invalidate it to remove the cached document.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the CIMD policy.
", "smithy.api#required": {} } }, "CIMDPolicyId": { "target": "com.amazonaws.cognitoidentityprovider#CIMDPolicyIdType", "traits": { "smithy.api#documentation": "The ID of the CIMD policy that the URL belongs to.
", "smithy.api#required": {} } }, "URL": { "target": "com.amazonaws.cognitoidentityprovider#MetadataURLType", "traits": { "smithy.api#documentation": "The client metadata document URL whose cache state you want to change.
", "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.cognitoidentityprovider#CIMDCacheActionType", "traits": { "smithy.api#documentation": "The action to take on the cached client metadata document. REFRESH\n retrieves the document from the URL again. INVALIDATE removes the cached\n document.
Updates the status of a the currently signed-in user's device so that it is\n marked as remembered or not remembered for the purpose of device authentication. Device\n authentication is a \"remember me\" mechanism that silently completes sign-in from trusted\n devices with a device key instead of a user-provided MFA code. This operation changes\n the status of a device without deleting it, so you can enable it again later. For more\n information about device authentication, see Working with devices.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The device key of the device you want to update, for example\n us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
To enable device authentication with the specified device, set to\n remembered.To disable, set to not_remembered.
Represents the request to update the device status.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateDeviceStatusResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The response to the request to update the device status.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateGroup": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateGroupRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateGroupResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Given the name of a user pool group, updates any of the properties for precedence,\n IAM role, or description. For more information about user pool groups, see Adding groups to a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the group that you want to update.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the group you want to update.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.cognitoidentityprovider#DescriptionType", "traits": { "smithy.api#documentation": "A new description of the existing group.
" } }, "RoleArn": { "target": "com.amazonaws.cognitoidentityprovider#ArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that you want to associate with the\n group. The role assignment contributes to the cognito:roles and\n cognito:preferred_role claims in group members' tokens.
A non-negative integer value that specifies the precedence of this group relative to\n the other groups that a user can belong to in the user pool. Zero is the highest\n precedence value. Groups with lower Precedence values take precedence over\n groups with higher or null Precedence values. If a user belongs to two or\n more groups, it is the group with the lowest precedence value whose role ARN is given in\n the user's tokens for the cognito:roles and\n cognito:preferred_role claims.
Two groups can have the same Precedence value. If this happens, neither\n group takes precedence over the other. If two groups with the same\n Precedence have the same role ARN, that role is used in the\n cognito:preferred_role claim in tokens for users in each group. If the\n two groups have different role ARNs, the cognito:preferred_role claim isn't\n set in users' tokens.
The default Precedence value is null. The maximum Precedence\n value is 2^31-1.
Contains the updated details of the group, including precedence, IAM role, and\n description.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateIdentityProvider": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateIdentityProviderRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateIdentityProviderResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnsupportedIdentityProviderException" } ], "traits": { "smithy.api#documentation": "Modifies the configuration and trust relationship between a third-party identity\n provider (IdP) and a user pool. Amazon Cognito accepts sign-in with third-party identity\n providers through managed login and OIDC relying-party libraries. For more information,\n see Third-party IdP sign-in.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe Id of the user pool where you want to update your IdP.
", "smithy.api#required": {} } }, "ProviderName": { "target": "com.amazonaws.cognitoidentityprovider#ProviderNameType", "traits": { "smithy.api#documentation": "The name of the IdP that you want to update. You can pass the identity provider name\n in the identity_provider query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated\n IdP.
The scopes, URLs, and identifiers for your external identity provider. The following\nexamples describe the provider detail keys for each IdP type. These values and their\nschema are subject to change. Social IdP authorize_scopes values must match\nthe values listed here.
Amazon Cognito accepts the following elements when it can't discover endpoint\n URLs from oidc_issuer: attributes_url,\n authorize_url, jwks_uri,\n token_url.
Create or update request: \"ProviderDetails\": {\n \"attributes_request_method\": \"GET\", \"attributes_url\":\n \"https://auth.example.com/userInfo\", \"authorize_scopes\": \"openid profile\n email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n \"client_id\": \"1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"jwks_uri\":\n \"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n \"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n }\n
Describe response: \"ProviderDetails\": { \"attributes_request_method\":\n \"GET\", \"attributes_url\": \"https://auth.example.com/userInfo\",\n \"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"openid\n profile email\", \"authorize_url\": \"https://auth.example.com/authorize\",\n \"client_id\": \"1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"jwks_uri\":\n \"https://auth.example.com/.well-known/jwks.json\", \"oidc_issuer\":\n \"https://auth.example.com\", \"token_url\": \"https://example.com/token\"\n }\n
Create or update request with Metadata URL: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"MetadataURL\":\n \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\" }\n
Create or update request with Metadata file: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \n \"MetadataFile\": \"[metadata XML]\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\" }\n
The value of MetadataFile must be the plaintext metadata document with all \n quote (\") characters escaped by backslashes.
Describe response: \"ProviderDetails\": { \"IDPInit\": \"true\",\n \"IDPSignout\": \"true\", \"EncryptedResponses\" : \"true\", \"ActiveEncryptionCertificate\": \"[certificate]\",\n \"MetadataURL\": \"https://auth.example.com/sso/saml/metadata\", \"RequestSigningAlgorithm\":\n \"rsa-sha256\", \"SLORedirectBindingURI\":\n \"https://auth.example.com/slo/saml\", \"SSORedirectBindingURI\":\n \"https://auth.example.com/sso/saml\" }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"profile postal_code\", \"client_id\":\n \"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n \"provider-app-client-secret\"\n
Describe response: \"ProviderDetails\": { \"attributes_url\":\n \"https://api.amazon.com/user/profile\", \"attributes_url_add_attributes\":\n \"false\", \"authorize_scopes\": \"profile postal_code\", \"authorize_url\":\n \"https://www.amazon.com/ap/oa\", \"client_id\":\n \"amzn1.application-oa2-client.1example23456789\", \"client_secret\":\n \"provider-app-client-secret\", \"token_request_method\": \"POST\",\n \"token_url\": \"https://api.amazon.com/auth/o2/token\" }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"email profile openid\", \"client_id\":\n \"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n \"provider-app-client-secret\" }\n
Describe response: \"ProviderDetails\": { \"attributes_url\":\n \"https://people.googleapis.com/v1/people/me?personFields=\",\n \"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"email\n profile openid\", \"authorize_url\":\n \"https://accounts.google.com/o/oauth2/v2/auth\", \"client_id\":\n \"1example23456789.apps.googleusercontent.com\", \"client_secret\":\n \"provider-app-client-secret\", \"oidc_issuer\":\n \"https://accounts.google.com\", \"token_request_method\": \"POST\",\n \"token_url\": \"https://www.googleapis.com/oauth2/v4/token\"\n }\n
Create or update request: \"ProviderDetails\": { \"authorize_scopes\":\n \"email name\", \"client_id\": \"com.example.cognito\", \"private_key\": \"1EXAMPLE\", \n \"key_id\": \"2EXAMPLE\", \"team_id\": \"3EXAMPLE\" }\n
Describe response: \"ProviderDetails\": {\n \"attributes_url_add_attributes\": \"false\", \"authorize_scopes\": \"email\n name\", \"authorize_url\": \"https://appleid.apple.com/auth/authorize\",\n \"client_id\": \"com.example.cognito\", \"key_id\": \"1EXAMPLE\", \"oidc_issuer\":\n \"https://appleid.apple.com\", \"team_id\": \"2EXAMPLE\",\n \"token_request_method\": \"POST\", \"token_url\":\n \"https://appleid.apple.com/auth/token\" }\n
Create or update request: \"ProviderDetails\": { \"api_version\": \"v17.0\", \n \"authorize_scopes\": \"public_profile, email\", \"client_id\": \"1example23456789\", \n \"client_secret\": \"provider-app-client-secret\" }\n
Describe response: \"ProviderDetails\": \n { \"api_version\": \"v17.0\", \"attributes_url\": \"https://graph.facebook.com/v17.0/me?fields=\", \n \"attributes_url_add_attributes\": \"true\", \"authorize_scopes\": \"public_profile, email\", \n \"authorize_url\": \"https://www.facebook.com/v17.0/dialog/oauth\", \"client_id\": \n \"1example23456789\", \"client_secret\": \"provider-app-client-secret\", \"token_request_method\": \n \"GET\", \"token_url\": \"https://graph.facebook.com/v17.0/oauth/access_token\" }\n
A mapping of IdP attributes to standard and custom user pool attributes. Specify a\n user pool attribute as the key of the key-value pair, and the IdP attribute claim name\n as the value.
" } }, "IdpIdentifiers": { "target": "com.amazonaws.cognitoidentityprovider#IdpIdentifiersListType", "traits": { "smithy.api#documentation": "An array of IdP identifiers, for example \"IdPIdentifiers\": [ \"MyIdP\", \"MyIdP2\"\n ]. Identifiers are friendly names that you can pass in the\n idp_identifier query parameter of requests to the Authorize endpoint to silently redirect to sign-in with the associated IdP.\n Identifiers in a domain format also enable the use of email-address matching with SAML providers.
A mapping between the authentication context class reference (ACR) levels of your user\n pool and the ACR values of the external OpenID Connect (OIDC) identity provider (IdP).\n This mapping has the same behavior as it does when you create an identity provider. Only\n OIDC IdPs support ACR mapping.
\nSetting AcrMapping is available in all feature plans. It isn't restricted\n to the Essentials or Plus feature plan.
The identity provider details.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBranding": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Configures the branding settings for a user pool style. This operation is the\n programmatic option for the configuration of a style in the branding editor.
\nProvides values for UI customization in a Settings JSON object and image\n files in an Assets array.
This operation has a 2-megabyte request-size limit and include the CSS settings and\n image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito\n doesn't require that you pass all parameters in one request and preserves existing\n style settings that you don't specify. If your request is larger than 2MB, separate it\n into multiple requests, each with a size smaller than the limit.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the managed login branding style that you want\n to update.
" } }, "ManagedLoginBrandingId": { "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingIdType", "traits": { "smithy.api#documentation": "The ID of the managed login branding style that you want to update.
" } }, "UseCognitoProvidedValues": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { "smithy.api#default": false, "smithy.api#documentation": "When true, applies the default branding style options. This option\n reverts to default style options that are managed by Amazon Cognito. You can modify them later in\n the branding editor.
When you specify true for this option, you must also omit values for\n Settings and Assets in the request.
A JSON file, encoded as a Document type, with the the settings that you\n want to apply to your style.
The following components are not currently implemented and reserved for future\n use:
\n\n signUp\n
\n instructions\n
\n sessionTimerDisplay\n
\n languageSelector (for localization, see Managed login localization)\n
An array of image files that you want to apply to roles like backgrounds, logos, and\n icons. Each object must also indicate whether it is for dark mode, light mode, or\n browser-adaptive mode.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateManagedLoginBrandingResponse": { "type": "structure", "members": { "ManagedLoginBranding": { "target": "com.amazonaws.cognitoidentityprovider#ManagedLoginBrandingType", "traits": { "smithy.api#documentation": "The details of the branding style that you updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateProvisionedLimit": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateProvisionedLimitRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateProvisionedLimitResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#ServiceQuotaExceededException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Sets the provisioned limit for a specific API category. The value must be between the\n default limit and your account-level maximum limit in Service Quotas.
\nManaged login user pools don't support adjustments to the\n UserAuthentication or UserFederation categories. To\n increase these limits, submit a Service Quotas increase request.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe limit to update. Specify the limit class and the attributes that identify the\n limit.
", "smithy.api#required": {} } }, "RequestedLimitValue": { "target": "com.amazonaws.cognitoidentityprovider#IntegerType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The provisioned rate to set, in requests per second (RPS).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateProvisionedLimitResponse": { "type": "structure", "members": { "Limit": { "target": "com.amazonaws.cognitoidentityprovider#LimitType", "traits": { "smithy.api#documentation": "The updated provisioned and default limit values.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateReplicaStatusType": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } } } }, "com.amazonaws.cognitoidentityprovider#UpdateResourceServer": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateResourceServerRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateResourceServerResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Updates the name and scopes of a resource server. All other fields are read-only. For\n more information about resource servers, see Access control with resource servers.
\nIf you don't provide a value for an attribute, it is set to the default\n value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the resource server that you want to\n update.
", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerIdentifierType", "traits": { "smithy.api#documentation": "A unique resource server identifier for the resource server. The identifier can be an\n API friendly name like solar-system-data. You can also set an API URL like\n https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format\n $resource-server-identifier/$scope. Longer scope-identifier strings\n increase the size of your access tokens.
The updated name of the resource server.
", "smithy.api#required": {} } }, "Scopes": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerScopeListType", "traits": { "smithy.api#documentation": "An array of updated custom scope names and descriptions that you want to associate\n with your resource server.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateResourceServerResponse": { "type": "structure", "members": { "ResourceServer": { "target": "com.amazonaws.cognitoidentityprovider#ResourceServerType", "traits": { "smithy.api#documentation": "The updated details of the requested resource server.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateTerms": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateTermsRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateTermsResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TermsExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Modifies existing terms documents for the requested app client. When Terms and\n conditions and Privacy policy documents are configured, the app client displays links to\n them in the sign-up page of managed login for the app client.
\nYou can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for\n their current language, with fallback to default if no document exists for\n the language.
Each request accepts one type of terms document and a map of language-to-link for that\n document type. You must provide both types of terms documents in at least one language\n before Amazon Cognito displays your terms documents. Supply each type in separate\n requests.
\nFor more information, see Terms documents.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the terms document that you want to update.
", "smithy.api#required": {} } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that contains the terms that you want to update.
", "smithy.api#required": {} } }, "TermsName": { "target": "com.amazonaws.cognitoidentityprovider#TermsNameType", "traits": { "smithy.api#documentation": "The new name that you want to apply to the requested terms documents.
" } }, "TermsSource": { "target": "com.amazonaws.cognitoidentityprovider#TermsSourceType", "traits": { "smithy.api#documentation": "This parameter is reserved for future use and currently accepts only one value.
" } }, "Enforcement": { "target": "com.amazonaws.cognitoidentityprovider#TermsEnforcementType", "traits": { "smithy.api#documentation": "This parameter is reserved for future use and currently accepts only one value.
" } }, "Links": { "target": "com.amazonaws.cognitoidentityprovider#LinksType", "traits": { "smithy.api#documentation": "A map of URLs to languages. For each localized language that will view the requested\n TermsName, assign a URL. A selection of cognito:default\n displays for all languages that don't have a language-specific URL.
For example, \"cognito:default\": \"https://terms.example.com\", \"cognito:spanish\":\n \"https://terms.example.com/es\".
A summary of the updates to your terms documents.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserAttributes": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserAttributesRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserAttributesResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#AliasExistsException" }, { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryFailureException" }, { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#ExpiredCodeException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidLambdaResponseException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UnexpectedLambdaException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Updates the currently signed-in user's attributes. To delete an attribute from\n the user, submit the attribute in your API request with a blank value.
\nFor custom attributes, you must add a custom: prefix to the attribute\n name, for example custom:department.
Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAn array of name-value pairs representing user attributes.
\nFor custom attributes, you must add a custom: prefix to the attribute\n name.
If you have set an attribute to require verification before Amazon Cognito updates its value,\n this request doesn\u2019t immediately update the value of that attribute. After your user\n receives and responds to a verification message to verify the new value, Amazon Cognito updates\n the attribute value. Your user can sign in and receive messages with the original\n attribute value until they verify the new value.
", "smithy.api#required": {} } }, "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TokenModelType", "traits": { "smithy.api#documentation": "A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
A map of custom key-value pairs that you can provide as input for any custom workflows\n that this action triggers. You create custom workflows by assigning Lambda functions\n to user pool triggers.
\nWhen Amazon Cognito invokes any of these functions, it passes a JSON payload, which the\n function receives as input. This payload contains a clientMetadata\n attribute that provides the data that you assigned to the ClientMetadata parameter in\n your request. In your function code, you can process the clientMetadata\n value to enhance your workflow for your specific needs.
To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see \nConnecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.
\nWhen you use the ClientMetadata parameter, note that Amazon Cognito won't do the\n following:
Store the ClientMetadata value. This data is available only\n to Lambda triggers that are assigned to a user pool to support custom\n workflows. If your user pool configuration doesn't include triggers, the\n ClientMetadata parameter serves no purpose.
Validate the ClientMetadata value.
Encrypt the ClientMetadata value. Don't send sensitive\n information in this parameter.
Represents the request to update user attributes.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserAttributesResponse": { "type": "structure", "members": { "CodeDeliveryDetailsList": { "target": "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsListType", "traits": { "smithy.api#documentation": "When the attribute-update request includes an email address or phone number attribute,\n Amazon Cognito sends a message to users with a code that confirms ownership of the new value that\n they entered. The CodeDeliveryDetails object is information about the\n delivery destination for that link or code. This behavior happens in user pools\n configured to automatically verify changes to those attributes. For more information,\n see Verifying when users change their email or phone\n number.
Represents the response from the server for the request to update user\n attributes.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPool": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidEmailRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleAccessPolicyException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidSmsRoleTrustRelationshipException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TierChangeNotAllowedException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserImportInProgressException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTaggingException" } ], "traits": { "smithy.api#documentation": "Updates the configuration of a user pool. To avoid setting parameters to Amazon Cognito\n defaults, construct this API request to pass the existing configuration of your user\n pool, modified to include the changes that you want to make.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nIn secondary regions for user pools with multi-region replication, regional\n configurations for email, SMS, Lambda functions, and tags can be updated. Both global\n and regional settings must be provided as inputs, with global settings required to match\n existing values to maintain consistency across replicas.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nGiven a user pool app client ID, updates the configuration. To avoid setting\n parameters to Amazon Cognito defaults, construct this API request to pass the existing\n configuration of your app client, modified to include the changes that you want to\n make.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nUnlike app clients created in the console, Amazon Cognito doesn't automatically assign a \nbranding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't \navailable for your client until after you apply a branding style.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool where you want to update the app client.
", "smithy.api#required": {} } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client that you want to update.
", "smithy.api#required": {} } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { "smithy.api#documentation": "A friendly name for the app client.
" } }, "RefreshTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#RefreshTokenValidityType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The refresh token time limit. After this limit expires, your user can't use \ntheir refresh token. To specify the time unit for RefreshTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and\nTokenValidityUnits as days, your user can refresh their session\nand retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. \nYou can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the \nvalue with the default value of 30 days. Valid range is displayed below \nin seconds.
If you don't specify otherwise in the configuration of your app client, your refresh\ntokens are valid for 30 days.
" } }, "AccessTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType", "traits": { "smithy.api#documentation": "The access token time limit. After this limit expires, your user can't use \ntheir access token. To specify the time unit for AccessTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and\nTokenValidityUnits to hours, your user can authorize access with\ntheir access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. \nValid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access\ntokens are valid for one hour.
" } }, "IdTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { "smithy.api#documentation": "The ID token time limit. After this limit expires, your user can't use \ntheir ID token. To specify the time unit for IdTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and\nTokenValidityUnits as hours, your user can authenticate their \nsession with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. \nValid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID\ntokens are valid for one hour.
" } }, "TokenValidityUnits": { "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { "smithy.api#documentation": "The units that validity times are represented in. The default unit for refresh tokens\n is days, and the default for ID and access tokens are hours.
" } }, "ReadAttributes": { "target": "com.amazonaws.cognitoidentityprovider#ClientPermissionListType", "traits": { "smithy.api#documentation": "The list of user attributes that you want your app client to have read access to.\n After your user authenticates in your app, their access token authorizes them to read\n their own attribute value for any attribute in this list.
\nWhen you don't specify the ReadAttributes for your app client, your\n app can read the values of email_verified,\n phone_number_verified, and the standard attributes of your user pool.\n When your user pool app client has read access to these default attributes,\n ReadAttributes doesn't return any information. Amazon Cognito only\n populates ReadAttributes in the API response if you have specified your own\n custom set of read attributes.
The list of user attributes that you want your app client to have write access to.\n After your user authenticates in your app, their access token authorizes them to set or\n modify their own attribute value for any attribute in this list.
\nWhen you don't specify the WriteAttributes for your app client, your\n app can write the values of the Standard attributes of your user pool. When your user\n pool has write access to these default attributes, WriteAttributes\n doesn't return any information. Amazon Cognito only populates\n WriteAttributes in the API response if you have specified your own\n custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all\n attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when\n users sign in to your application through an IdP. If your app client does not have write\n access to a mapped attribute, Amazon Cognito throws an error when it tries to update the\n attribute. For more information, see Specifying IdP Attribute Mappings for Your user\n pool.
" } }, "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { "smithy.api#documentation": "The authentication flows that you want your user pool client to support. For each app \nclient in your user pool, you can sign in your users with any combination of one or more flows, including with \na user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that \nyou define with Lambda functions.
\nIf you don't specify a value for ExplicitAuthFlows, your app client supports \nALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.\n
The values for authentication flow options include the following.
\n\n ALLOW_USER_AUTH: Enable selection-based sign-in\n with USER_AUTH. This setting covers username-password,\n secure remote password (SRP), passwordless, and passkey authentication.\n This authentiation flow can do username-password and SRP authentication\n without other ExplicitAuthFlows permitting them. For example\n users can complete an SRP challenge through USER_AUTH \n without the flow USER_SRP_AUTH being active for the app\n client. This flow doesn't include CUSTOM_AUTH.\n
To activate this setting, your user pool must be in the \n Essentials tier or higher.
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces\n the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app\n passes a user name and password to Amazon Cognito in the request, instead of using the Secure \n Remote Password (SRP) protocol to securely transmit the password.
\n ALLOW_CUSTOM_AUTH: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh\n tokens.
\n ALLOW_TOKEN_EXCHANGE_IMPERSONATION \u2013 Use this flow to request\n GetDerivedToken token exchanges without an ActorToken.\n The issued token represents the subject user directly.
\n ALLOW_TOKEN_EXCHANGE_DELEGATION \u2013 Use this flow to request\n GetDerivedToken token exchanges that include an\n ActorToken. The issued token carries an act claim that\n identifies the intermediary acting on the behalf of the subject.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.
A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.
This parameter sets the IdPs that managed \n login will display on the login page for your app client. The removal of \n COGNITO from this list doesn't prevent authentication operations \n for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent \n SDK-based authentication is to block access with a WAF rule.\n
A list of allowed redirect, or callback, URLs for managed login authentication. These\n URLs are the paths where you want to send your users' browsers after they complete\n authentication with managed login or a third-party IdP. Typically, callback URLs are the\n home of an application that uses OAuth or OIDC libraries to process authentication\n outcomes.
\nA redirect URI must meet the following requirements:
\nBe an absolute URI.
\nBe registered with the authorization server. Amazon Cognito doesn't accept\n authorization requests with redirect_uri values that aren't in\n the list of CallbackURLs that you provide in this parameter.
Not include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes\n only.
\nApp callback URLs such as myapp://example are also supported.
A list of allowed logout URLs for managed login authentication. When you pass\n logout_uri and client_id parameters to\n /logout, Amazon Cognito signs out your user and redirects them to the logout\n URL. This parameter describes the URLs that you want to be the permitted targets of\n logout_uri. A typical use of these URLs is when a user selects \"Sign\n out\" and you redirect them to your public homepage. For more information, see Logout\n endpoint.
The default redirect URI. In app clients with one assigned IdP, replaces\n redirect_uri in authentication requests. Must be in the\n CallbackURLs list.
The OAuth grant types that you want your app client to generate. To create an app\n client that generates client credentials grants, you must add\n client_credentials as the only allowed OAuth flow.
Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.
\nIssue the access token from the /oauth2/token endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app\n client to authorize access with. Scopes govern access control to user pool self-service\n API operations, user data from the userInfo endpoint, and third-party APIs.\n Scope values include phone, email, openid, and\n profile. The aws.cognito.signin.user.admin scope\n authorizes user self-service operations. Custom scopes with resource servers authorize\n access to external APIs.
Set to true to use OAuth 2.0 authorization server features in your app client.
This parameter must have a value of true before you can configure \nthe following features in your app client.
\n CallBackURLs: Callback URLs.
\n LogoutURLs: Sign-out redirect URLs.
\n AllowedOAuthScopes: OAuth 2.0 scopes.
\n AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set \nAllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or \nUpdateUserPoolClient API request. If you don't set a value for \nAllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults \nto false. When false, only SDK-based API sign-in is permitted.
The user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to\n analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For\n more information, see Using Amazon Pinpoint analytics.
" } }, "PreventUserExistenceErrors": { "target": "com.amazonaws.cognitoidentityprovider#PreventUserExistenceErrorTypes", "traits": { "smithy.api#documentation": "When ENABLED, suppresses messages that might indicate a valid user exists \n when someone attempts sign-in. This parameters sets your preference for the errors and \n responses that you want Amazon Cognito APIs to return during authentication, account\n confirmation, and password recovery when the user doesn't exist in the user pool. When\n set to ENABLED and the user doesn't exist, authentication returns an error\n indicating either the username or password was incorrect. Account confirmation and\n password recovery return a response indicating a code was sent to a simulated\n destination. When set to LEGACY, those APIs return a\n UserNotFoundException exception if the user doesn't exist in the user\n pool.
Defaults to LEGACY.
Activates or deactivates token\n revocation in the target app client.
" } }, "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "When true, your application can include additional\n UserContextData in authentication requests. This data includes the IP\n address, and contributes to analysis by threat protection features. For more information\n about propagation of user context data, see Adding session data to API requests. If you don\u2019t include this parameter,\n you can't send the source IP address to Amazon Cognito threat protection features. You can only\n activate EnablePropagateAdditionalUserContextData in an app client that has\n a client secret.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.
" } }, "PublishSecretsInAWSSecretsManager": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "Specifies whether Amazon Cognito stores and manages this app client's secret in\n Amazon Web Services\n Secrets Manager instead of returning the plaintext value. When you set this\n parameter to true, the response returns ClientSecretArn\n instead of ClientSecret. By default, Amazon Cognito rotates the secret every 7 days.\n You can change the rotation schedule in Secrets Manager.
Set to true to migrate an existing generated secret into Secrets Manager,\n or false to move it back to Amazon Cognito and delete the Secrets Manager secret. If\n you omit this parameter, Amazon Cognito doesn't change how it manages the existing secret.\n Applies only to app clients that already have a generated secret.
When you set it to true, Amazon Cognito starts managing the app client's\n secret in Secrets Manager and rotates it right away. If the app client has two secrets,\n that first rotation deletes the older one.
When you set this parameter to false, Amazon Cognito immediately and\n permanently deletes the Secrets Manager secret. There's no recovery window.\n Applications that read the secret from Secrets Manager can no longer get it.
Represents the request to update the user pool client.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolClientResponse": { "type": "structure", "members": { "UserPoolClient": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientType", "traits": { "smithy.api#documentation": "The updated details of your app client.
" } } }, "traits": { "smithy.api#documentation": "Represents the response from the server to the request to update the user pool\n client.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomain": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#ConcurrentModificationException" }, { "target": "com.amazonaws.cognitoidentityprovider#FeatureUnavailableInTierException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "A user pool domain hosts managed login, an authorization server and web server for\n authentication in your application. This operation updates the branding version for user\n pool domains between 1 for hosted UI (classic) and 2 for\n managed login. It also updates the SSL certificate for user pool custom domains.
Changes to the domain branding version take up to one minute to take effect for a\n prefix domain and up to five minutes for a custom domain.
\nThis operation doesn't change the name of your user pool domain. To change your\n domain, delete it with DeleteUserPoolDomain and create a new domain with\n CreateUserPoolDomain.
You can pass the ARN of a new Certificate Manager certificate in this request. Typically, ACM\n certificates automatically renew and you user pool can continue to use the same ARN. But\n if you generate a new certificate for your custom domain name, replace the original\n configuration with the new ARN in this request.
\nACM certificates for custom domains must be in the US East (N. Virginia)\n Amazon Web Services Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute\n your new certificate to your custom domain.
\nFor more information about adding a custom domain to your user pool, see Configuring a user pool domain.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe name of the domain that you want to update. For custom domains, this is the\n fully-qualified domain name, for example auth.example.com. For prefix\n domains, this is the prefix alone, such as myprefix.
The ID of the user pool that is associated with the domain you're updating.
", "smithy.api#required": {} } }, "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { "smithy.api#documentation": "A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding editor. For more information, see Managed login.
The configuration for a custom domain that hosts managed login for your application.\n In an UpdateUserPoolDomain request, this parameter specifies an SSL\n certificate for the managed login hosted webserver. The certificate must be an ACM ARN\n in us-east-1.
When you create a custom domain, the passkey RP ID defaults to the custom domain. If\n you had a prefix domain active, this will cause passkey integration for your prefix\n domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey\n integration working, you can explicitly set RP ID to the prefix domain.
" } }, "Routing": { "target": "com.amazonaws.cognitoidentityprovider#RoutingType", "traits": { "smithy.api#documentation": "The routing configuration for the user pool domain. Specifies failover settings for\n multi-region deployments.
" } } }, "traits": { "smithy.api#documentation": "The UpdateUserPoolDomain request input.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolDomainResponse": { "type": "structure", "members": { "ManagedLoginVersion": { "target": "com.amazonaws.cognitoidentityprovider#WrappedIntegerType", "traits": { "smithy.api#documentation": "A version number that indicates the state of managed login for your domain. Version\n 1 is hosted UI (classic). Version 2 is the newer managed\n login with the branding editor. For more information, see Managed login.
The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your\n managed login or classic hosted UI pages. You domain-name authority must have an alias\n record that points requests for your custom domain to this FQDN. Amazon Cognito returns this\n value if you set a custom domain with CustomDomainConfig. If you set an\n Amazon Cognito prefix domain, this operation returns a blank response.
The updated routing configuration for the user pool domain.
" } } }, "traits": { "smithy.api#documentation": "The UpdateUserPoolDomain response output.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolReplica": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolReplicaRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#UpdateUserPoolReplicaResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Updates replica-specific settings for a user pool replica. You can modify the status\n to activate or deactivate the replica. This request can be made in both primary and secondary\n regions of the user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe ID of the user pool that contains the replica to update.
", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.cognitoidentityprovider#RegionNameType", "traits": { "smithy.api#documentation": "The Amazon Web Services Region of the replica to update.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cognitoidentityprovider#UpdateReplicaStatusType", "traits": { "smithy.api#documentation": "The status to set for the replica. Valid values are ACTIVE and INACTIVE.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolReplicaResponse": { "type": "structure", "members": { "UserPoolReplica": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolReplicaType", "traits": { "smithy.api#documentation": "Information about the updated user pool replica.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolRequest": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool you want to update.
", "smithy.api#required": {} } }, "Policies": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { "smithy.api#documentation": "The password policy and sign-in policy in the user pool. The password policy sets\n options like password complexity requirements and password history. The sign-in policy\n sets the options available to applications in choice-based authentication.
" } }, "DeletionProtection": { "target": "com.amazonaws.cognitoidentityprovider#DeletionProtectionType", "traits": { "smithy.api#documentation": "When active, DeletionProtection prevents accidental deletion of your user\npool. Before you can delete a user pool that you have protected against deletion, you\nmust deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, \nAmazon Cognito returns an InvalidParameterException error. To delete a protected user pool, \nsend a new DeleteUserPool request after you deactivate deletion protection in an \nUpdateUserPool API request.
A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of authentication operations. Triggers can modify the outcome of the operations\n that invoked them.
" } }, "AutoVerifiedAttributes": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { "smithy.api#documentation": "The attributes that you want your user pool to automatically verify. Possible values:\n email, phone_number. For more information see Verifying contact information at sign-up.
" } }, "SmsVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "VerificationMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { "smithy.api#documentation": "The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.
\nSet the email message type that corresponds to your DefaultEmailOption\n selection. For CONFIRM_WITH_LINK, specify an\n EmailMessageByLink and leave EmailMessage blank. For\n CONFIRM_WITH_CODE, specify an EmailMessage and leave\n EmailMessageByLink blank. When you supply both parameters with either\n choice, Amazon Cognito returns an error.
The contents of the SMS message that your user pool sends to users in SMS\n authentication.
" } }, "UserAttributeUpdateSettings": { "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", "traits": { "smithy.api#documentation": "The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to email addresses and phone numbers.
Sets multi-factor authentication (MFA) to be on, off, or optional. When\n ON, all users must set up MFA before they can sign in. When\n OPTIONAL, your application must make a client-side determination of\n whether a user wants to register an MFA device. For user pools with adaptive\n authentication with threat protection, choose OPTIONAL.
When MfaConfiguration is OPTIONAL, managed login\n doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in\n API responses and in managed login for users who have chosen and configured a preferred\n MFA factor.
The device-remembering configuration for a user pool. Device remembering or device\n tracking is a \"Remember me on this device\" option for user pools that perform\n authentication with the device key of a trusted device in the back end, instead of a\n user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. A null value indicates that\n you have deactivated device remembering in your user pool.
\nWhen you provide a value for any DeviceConfiguration field, you\n activate the Amazon Cognito device-remembering feature. For more information, see Working with devices.
The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for email invitation and verification\n messages from your user pool.
" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { "smithy.api#documentation": "The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message\n with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the\n Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For\n more information see SMS message settings.
" } }, "UserPoolTags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { "smithy.api#documentation": "The tag keys and values to assign to the user pool. A tag is a label that you can use\n to categorize and manage user pools in different ways, such as by purpose, owner,\n environment, or other criteria.
" } }, "AdminCreateUserConfig": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", "traits": { "smithy.api#documentation": "The configuration for administrative creation of users. Includes the template for the\n invitation message for new users, the duration of temporary passwords, and permitting\n self-service sign-up.
" } }, "UserPoolAddOns": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType", "traits": { "smithy.api#documentation": "Contains settings for activation of threat protection, including the operating \nmode and additional authentication types. To log user security information but take \nno action, set to AUDIT. To configure automatic security responses to \npotentially unwanted traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the \n Plus tier.
" } }, "DcrConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DcrConfigurationType", "traits": { "smithy.api#documentation": "The dynamic client registration configuration for the user pool. With dynamic client\n registration, applications can register their own app clients at runtime through the\n registration endpoint of your user pool domain. To activate this setting, your user pool must be in the \n Essentials tier or higher.
\nIf you omit this parameter, Amazon Cognito keeps the existing configuration. If you include it,\n Amazon Cognito replaces the existing configuration with the one that you provide. Members that you\n omit revert to their default values, and an omitted EnableStatus turns\n dynamic client registration on.
To change the feature plan of the user pool to Lite, you must also set\n EnableStatus to Disabled.
The available verified method a user can use to recover their password when they call\n ForgotPassword. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.
The updated name of your user pool.
" } }, "UserPoolTier": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTierType", "traits": { "smithy.api#documentation": "The user pool feature plan, or tier. This parameter determines the\n eligibility of the user pool for features like managed login, access-token\n customization, and threat protection. Defaults to ESSENTIALS.
The key configuration for the user pool. In secondary regions, this parameter must\n match the existing configuration and cannot be modified.
" } }, "IssuerConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#IssuerConfigurationType", "traits": { "smithy.api#documentation": "The issuer configuration for the user pool. In secondary regions, this parameter must\n match the existing configuration and cannot be modified.
" } }, "AcrConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AcrConfigurationType", "traits": { "smithy.api#documentation": "The custom names for the authentication context class reference\n (ACR) levels in your user pool. This configuration has the same behavior as it does when\n you create a user pool: you customize only the URI name that Amazon Cognito reports for\n each of the four fixed ACR levels, and any level that you don't specify keeps its default\n name. Each name must be unique across all four levels, including default names.
\nConfiguring custom ACR level names requires the Essentials or Plus feature plan.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } } }, "traits": { "smithy.api#documentation": "Represents the request to update the user pool.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#UpdateUserPoolResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Represents the response from the server when you make a request to update the user\n pool.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType": { "type": "structure", "members": { "AttributesRequireVerificationBeforeUpdate": { "target": "com.amazonaws.cognitoidentityprovider#AttributesRequireVerificationBeforeUpdateType", "traits": { "smithy.api#documentation": "Requires that your user verifies their email address, phone number, or both before\n Amazon Cognito updates the value of that attribute. When you update a user attribute that has\n this option activated, Amazon Cognito sends a verification message to the new phone number or\n email address. Amazon Cognito doesn\u2019t change the value of the attribute until your user responds\n to the verification message and confirms the new value.
\nWhen AttributesRequireVerificationBeforeUpdate is false, your user pool\n doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a\n user pool where AttributesRequireVerificationBeforeUpdate is false, API\n operations that change attribute values can immediately update a user\u2019s\n email or phone_number attribute.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to email addresses and phone numbers.
The source IP address of your user's device.
" } }, "EncodedData": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "Encoded device-fingerprint details that your app collected with the Amazon Cognito\n context data collection library. For more information, see Adding user device and session data to API requests.
" } } }, "traits": { "smithy.api#documentation": "Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito threat protection.
", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#UserFilterType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.cognitoidentityprovider#UserImportInProgressException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the user pool has an import job running.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when you're trying to modify a user pool while a user import\n job is in progress for that pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UserImportJobIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 55 }, "smithy.api#pattern": "^import-[0-9a-zA-Z-]+$" } }, "com.amazonaws.cognitoidentityprovider#UserImportJobNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w\\s+=,.@-]+$" } }, "com.amazonaws.cognitoidentityprovider#UserImportJobStatusType": { "type": "enum", "members": { "Created": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Created" } }, "Pending": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Pending" } }, "InProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "Stopping": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stopping" } }, "Expired": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Expired" } }, "Stopped": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stopped" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Succeeded" } } } }, "com.amazonaws.cognitoidentityprovider#UserImportJobType": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobNameType", "traits": { "smithy.api#documentation": "The friendly name of the user import job.
" } }, "JobId": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobIdType", "traits": { "smithy.api#documentation": "The ID of the user import job.
" } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that the users are being imported into.
" } }, "PreSignedUrl": { "target": "com.amazonaws.cognitoidentityprovider#PreSignedUrlType", "traits": { "smithy.api#documentation": "The pre-signed URL target for uploading the CSV file.
" } }, "CreationDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date when the user import job was started.
" } }, "CompletionDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date when the user import job was completed.
" } }, "Status": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobStatusType", "traits": { "smithy.api#documentation": "The status of the user import job. One of the following:
\n\n Created - The job was created but not started.
\n Pending - A transition state. You have started the job, but it\n has not begun importing users yet.
\n InProgress - The job has started, and users are being\n imported.
\n Stopping - You have stopped the job, but the job has not stopped\n importing users yet.
\n Stopped - You have stopped the job, and the job has stopped\n importing users.
\n Succeeded - The job has completed successfully.
\n Failed - The job has stopped due to an error.
\n Expired - You created a job, but did not start the job within\n 24-48 hours. All data associated with the job was deleted, and the job can't be\n started.
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import\n job. For more information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer\n Guide.
" } }, "ImportedUsers": { "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of users that were successfully imported.
" } }, "SkippedUsers": { "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of users that were skipped.
" } }, "FailedUsers": { "target": "com.amazonaws.cognitoidentityprovider#LongType", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The number of users that couldn't be imported.
" } }, "CompletionMessage": { "target": "com.amazonaws.cognitoidentityprovider#CompletionMessageType", "traits": { "smithy.api#documentation": "The message returned when the user import job is completed.
" } }, "PasswordHashingAlgorithm": { "target": "com.amazonaws.cognitoidentityprovider#PasswordHashingAlgorithmType", "traits": { "smithy.api#documentation": "The password hashing algorithm used to generate the hashes in the CSV file for this\n import job.
\nValid values: BCRYPT | SCRYPT | ARGON2ID |\n PBKDF2_SHA256\n
A user import job in a user pool. Describes the status of user import with a CSV file.\n For more information, see Importing users into user pools from a CSV file.
" } }, "com.amazonaws.cognitoidentityprovider#UserImportJobsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#UserImportJobType" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.cognitoidentityprovider#UserLambdaValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when the Amazon Cognito service returns a user validation exception with\n the Lambda service.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when the Amazon Cognito service encounters a user validation exception\n with the Lambda service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UserMFASettingListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#StringType" } }, "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when a user isn't confirmed successfully.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user isn't confirmed successfully.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UserNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when a user isn't found.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user isn't found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.cognitoidentityprovider#UserPoolAddOnNotEnabledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when user pool add-ons aren't enabled.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UserPoolAddOnsType": { "type": "structure", "members": { "AdvancedSecurityMode": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityModeType", "traits": { "smithy.api#documentation": "The operating mode of threat protection for standard authentication types in your user\n pool, including username-password and secure remote password (SRP) authentication.\n
", "smithy.api#required": {} } }, "AdvancedSecurityAdditionalFlows": { "target": "com.amazonaws.cognitoidentityprovider#AdvancedSecurityAdditionalFlowsType", "traits": { "smithy.api#documentation": "Threat protection configuration options for additional authentication types in your\n user pool, including custom\n authentication.
" } } }, "traits": { "smithy.api#documentation": "Contains settings for activation of threat protection, including the operating \nmode and additional authentication types. To log user security information but take \nno action, set to AUDIT. To configure automatic security responses to \npotentially unwanted traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the \n Plus tier.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolClientDescription": { "type": "structure", "members": { "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The app client ID.
" } }, "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool that's associated with the app client.
" } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { "smithy.api#documentation": "The app client name.
" } } }, "traits": { "smithy.api#documentation": "A short description of a user pool app client.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolClientListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolClientDescription" } }, "com.amazonaws.cognitoidentityprovider#UserPoolClientType": { "type": "structure", "members": { "UserPoolId": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool associated with the app client.
" } }, "ClientName": { "target": "com.amazonaws.cognitoidentityprovider#ClientNameType", "traits": { "smithy.api#documentation": "The name of the app client.
" } }, "ClientId": { "target": "com.amazonaws.cognitoidentityprovider#ClientIdType", "traits": { "smithy.api#documentation": "The ID of the app client.
" } }, "ClientSecret": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretType", "traits": { "smithy.api#documentation": "The app client secret.
" } }, "ClientSecretArn": { "target": "com.amazonaws.cognitoidentityprovider#ClientSecretArnType", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets\n Manager secret that stores this app client's secret, when Amazon Cognito manages\n the secret in Secrets Manager. Retrieve the secret from Secrets Manager by this ARN.\n The SecretString value is a JSON object with userPoolId,\n userPoolClientId, and clientSecretValue fields. Use\n clientSecretValue as the app client secret. Amazon Cognito returns this ARN\n instead of ClientSecret for app clients whose secret it manages in Secrets\n Manager.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The refresh token time limit. After this limit expires, your user can't use \ntheir refresh token. To specify the time unit for RefreshTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and\nTokenValidityUnits as days, your user can refresh their session\nand retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days. \nYou can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the \nvalue with the default value of 30 days. Valid range is displayed below \nin seconds.
If you don't specify otherwise in the configuration of your app client, your refresh\ntokens are valid for 30 days.
" } }, "AccessTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#AccessTokenValidityType", "traits": { "smithy.api#documentation": "The access token time limit. After this limit expires, your user can't use \ntheir access token. To specify the time unit for AccessTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and\nTokenValidityUnits to hours, your user can authorize access with\ntheir access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours. \nValid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access\ntokens are valid for one hour.
" } }, "IdTokenValidity": { "target": "com.amazonaws.cognitoidentityprovider#IdTokenValidityType", "traits": { "smithy.api#documentation": "The ID token time limit. After this limit expires, your user can't use \ntheir ID token. To specify the time unit for IdTokenValidity as \nseconds, minutes, hours, or days, \nset a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and\nTokenValidityUnits as hours, your user can authenticate their \nsession with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours. \nValid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID\ntokens are valid for one hour.
" } }, "TokenValidityUnits": { "target": "com.amazonaws.cognitoidentityprovider#TokenValidityUnitsType", "traits": { "smithy.api#documentation": "The time units that, with IdTokenValidity,\n AccessTokenValidity, and RefreshTokenValidity, set and\n display the duration of ID, access, and refresh tokens for an app client. You can assign\n a separate token validity unit to each type of token.
The list of user attributes that you want your app client to have read access to.\n After your user authenticates in your app, their access token authorizes them to read\n their own attribute value for any attribute in this list.
\nWhen you don't specify the ReadAttributes for your app client, your\n app can read the values of email_verified,\n phone_number_verified, and the standard attributes of your user pool.\n When your user pool app client has read access to these default attributes,\n ReadAttributes doesn't return any information. Amazon Cognito only\n populates ReadAttributes in the API response if you have specified your own\n custom set of read attributes.
The list of user attributes that you want your app client to have write access to.\n After your user authenticates in your app, their access token authorizes them to set or\n modify their own attribute value for any attribute in this list.
\nWhen you don't specify the WriteAttributes for your app client, your\n app can write the values of the Standard attributes of your user pool. When your user\n pool has write access to these default attributes, WriteAttributes\n doesn't return any information. Amazon Cognito only populates\n WriteAttributes in the API response if you have specified your own\n custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all\n attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when\n users sign in to your application through an IdP. If your app client does not have write\n access to a mapped attribute, Amazon Cognito throws an error when it tries to update the\n attribute. For more information, see Specifying IdP Attribute Mappings for Your user\n pool.
" } }, "ExplicitAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#ExplicitAuthFlowsListType", "traits": { "smithy.api#documentation": "The authentication flows that you want your user pool client to support. For each app \nclient in your user pool, you can sign in your users with any combination of one or more flows, including with \na user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that \nyou define with Lambda functions.
\nIf you don't specify a value for ExplicitAuthFlows, your app client supports \nALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.\n
The values for authentication flow options include the following.
\n\n ALLOW_USER_AUTH: Enable selection-based sign-in\n with USER_AUTH. This setting covers username-password,\n secure remote password (SRP), passwordless, and passkey authentication.\n This authentiation flow can do username-password and SRP authentication\n without other ExplicitAuthFlows permitting them. For example\n users can complete an SRP challenge through USER_AUTH \n without the flow USER_SRP_AUTH being active for the app\n client. This flow doesn't include CUSTOM_AUTH.\n
To activate this setting, your user pool must be in the \n Essentials tier or higher.
\n\n ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password\n authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces\n the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app\n passes a user name and password to Amazon Cognito in the request, instead of using the Secure \n Remote Password (SRP) protocol to securely transmit the password.
\n ALLOW_CUSTOM_AUTH: Enable Lambda trigger based\n authentication.
\n ALLOW_USER_PASSWORD_AUTH: Enable user password-based\n authentication. In this flow, Amazon Cognito receives the password in the request instead\n of using the SRP protocol to verify passwords.
\n ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
\n ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh\n tokens.
\n ALLOW_TOKEN_EXCHANGE_IMPERSONATION \u2013 Use this flow to request\n GetDerivedToken token exchanges without an ActorToken.\n The issued token represents the subject user directly.
\n ALLOW_TOKEN_EXCHANGE_DELEGATION \u2013 Use this flow to request\n GetDerivedToken token exchanges that include an\n ActorToken. The issued token carries an act claim that\n identifies the intermediary acting on the behalf of the subject.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH. \nYou can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,\nlike ALLOW_USER_SRP_AUTH.
A list of provider names for the identity providers (IdPs) that are supported on this\n client. The following are supported: COGNITO, Facebook,\n Google, SignInWithApple, and LoginWithAmazon.\n You can also specify the names that you configured for the SAML and OIDC IdPs in your\n user pool, for example MySAMLIdP or MyOIDCIdP.
This parameter sets the IdPs that managed \n login will display on the login page for your app client. The removal of \n COGNITO from this list doesn't prevent authentication operations \n for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent \n SDK-based authentication is to block access with a WAF rule.\n
A list of allowed redirect (callback) URLs for the IdPs.
\nA redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP for callback URLs to http://localhost,\n http://127.0.0.1 and http://[::1]. These callback URLs are\n for testing purposes only. You can specify custom TCP ports for your callback\n URLs.
App callback URLs such as myapp://example are also supported.
" } }, "LogoutURLs": { "target": "com.amazonaws.cognitoidentityprovider#LogoutURLsListType", "traits": { "smithy.api#documentation": "A list of allowed logout URLs for the IdPs.
" } }, "DefaultRedirectURI": { "target": "com.amazonaws.cognitoidentityprovider#RedirectUrlType", "traits": { "smithy.api#documentation": "The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
\nBe an absolute URI.
\nBe registered with the authorization server.
\nNot include a fragment component.
\nSee OAuth 2.0 -\n Redirection Endpoint.
\nAmazon Cognito requires HTTPS over HTTP for callback URLs to http://localhost,\n http://127.0.0.1 and http://[::1]. These callback URLs are\n for testing purposes only. You can specify custom TCP ports for your callback\n URLs.
App callback URLs such as myapp://example are also supported.
" } }, "AllowedOAuthFlows": { "target": "com.amazonaws.cognitoidentityprovider#OAuthFlowsType", "traits": { "smithy.api#documentation": "The OAuth grant types that you want your app client to generate. To create an app\n client that generates client credentials grants, you must add\n client_credentials as the only allowed OAuth flow.
Use a code grant flow, which provides an authorization code as the\n response. This code can be exchanged for access tokens with the\n /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes)\n directly to your user.
\nIssue the access token from the /oauth2/token endpoint\n directly to a non-person user using a combination of the client ID and\n client secret.
The OAuth 2.0 scopes that you want your app client to support. Can include standard\n OAuth scopes like phone, email, openid, and\n profile. Can also include the\n aws.cognito.signin.user.admin scope that authorizes user profile\n self-service operations and custom scopes from resource servers.
Set to true to use OAuth 2.0 authorization server features in your app client.
This parameter must have a value of true before you can configure \nthe following features in your app client.
\n CallBackURLs: Callback URLs.
\n LogoutURLs: Sign-out redirect URLs.
\n AllowedOAuthScopes: OAuth 2.0 scopes.
\n AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use authorization server features, configure one of these features in the Amazon Cognito console or set \nAllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or \nUpdateUserPoolClient API request. If you don't set a value for \nAllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults \nto false. When false, only SDK-based API sign-in is permitted.
The user pool analytics configuration for collecting metrics and sending them to your\n Amazon Pinpoint campaign.
\nIn Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending\n events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is\n available, user pools support sending events to Amazon Pinpoint projects within that same\n Region.
\nWhen ENABLED, suppresses messages that might indicate a valid user exists \n when someone attempts sign-in. This parameters sets your preference for the errors and \n responses that you want Amazon Cognito APIs to return during authentication, account\n confirmation, and password recovery when the user doesn't exist in the user pool. When\n set to ENABLED and the user doesn't exist, authentication returns an error\n indicating either the username or password was incorrect. Account confirmation and\n password recovery return a response indicating a code was sent to a simulated\n destination. When set to LEGACY, those APIs return a\n UserNotFoundException exception if the user doesn't exist in the user\n pool.
Defaults to LEGACY.
Indicates whether token revocation is activated for the user pool client. When you\n create a new user pool client, token revocation is activated by default.
" } }, "EnablePropagateAdditionalUserContextData": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an\n IpAddress value that you send in the UserContextData\n parameter. The UserContextData parameter sends information to Amazon Cognito threat\n protection for risk analysis. You can send UserContextData when you sign in\n Amazon Cognito native users with the InitiateAuth and\n RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can't send\n your user's source IP address to Amazon Cognito threat protection with unauthenticated API\n operations. EnablePropagateAdditionalUserContextData doesn't affect whether\n you can send a source IP address in a ContextData parameter with the\n authenticated API operations AdminInitiateAuth and\n AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app\n client that has a client secret. For more information about propagation of user context\n data, see Adding user device and session data to API requests.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The configuration of your app client for refresh token rotation. When enabled, your\n app client issues new ID, access, and refresh tokens when users renew their sessions\n with refresh tokens. When disabled, token refresh issues only ID and access\n tokens.
" } }, "ClientType": { "target": "com.amazonaws.cognitoidentityprovider#ClientTypeType", "traits": { "smithy.api#documentation": "How the app client was created.
\nThe app client wasn't created through dynamic client registration.\n For example, you created it with CreateUserPoolClient.
An application registered the app client through dynamic client\n registration. These app clients don't support client secret operations\n such as AddUserPoolClientSecret, and they can't hold the\n aws.cognito/dcr/register scope.
The configuration of a user pool client.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolDescriptionType": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The user pool ID.
" } }, "Name": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", "traits": { "smithy.api#documentation": "The user pool name.
" } }, "LambdaConfig": { "target": "com.amazonaws.cognitoidentityprovider#LambdaConfigType", "traits": { "smithy.api#documentation": "A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.
" } }, "Status": { "target": "com.amazonaws.cognitoidentityprovider#StatusType", "traits": { "smithy.api#deprecated": { "message": "This property is no longer available." }, "smithy.api#documentation": "The user pool status.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A list of Amazon Web Services Regions where replicas of this user pool exist.
" } } }, "traits": { "smithy.api#documentation": "A short description of a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolIdType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 55 }, "smithy.api#pattern": "^[\\w-]+_[0-9a-zA-Z]+$" } }, "com.amazonaws.cognitoidentityprovider#UserPoolListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolDescriptionType" } }, "com.amazonaws.cognitoidentityprovider#UserPoolMfaType": { "type": "enum", "members": { "OFF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OFF" } }, "ON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON" } }, "OPTIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPTIONAL" } } } }, "com.amazonaws.cognitoidentityprovider#UserPoolNameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w\\s+=,.@-]+$" } }, "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType": { "type": "structure", "members": { "PasswordPolicy": { "target": "com.amazonaws.cognitoidentityprovider#PasswordPolicyType", "traits": { "smithy.api#documentation": "The password policy settings for a user pool, including complexity, history, and\n length requirements.
" } }, "SignInPolicy": { "target": "com.amazonaws.cognitoidentityprovider#SignInPolicyType", "traits": { "smithy.api#documentation": "The policy for allowed types of authentication in a user pool.
" } } }, "traits": { "smithy.api#documentation": "A list of user pool policies. Contains the policy that sets password-complexity\n requirements.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolReplicaListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolReplicaType" } }, "com.amazonaws.cognitoidentityprovider#UserPoolReplicaType": { "type": "structure", "members": { "RegionName": { "target": "com.amazonaws.cognitoidentityprovider#RegionNameType", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the replica is located.
" } }, "Status": { "target": "com.amazonaws.cognitoidentityprovider#ReplicaStatusType", "traits": { "smithy.api#documentation": "The current status of the replica.
\nThe replica is being created.
\nThe replica has been created, but is not accepting requests for end-users.\n Administrator configuration operations are supported.
\nThe replica is available for both end-user and administrator operations.
\nThe replica is being deleted.
\nThe role of the user pool replica that determines which API operations are enabled.
\nThe primary replica supports all end user and administrator operations.
\nThe secondary replica supports a limited set of end user and administrator operations.\n Generally, only administrator operations that set configurations specific to the replica, and\n only end-user operations that do not create or change attributes of a user are supported.\n
\nThe Amazon Resource Name (ARN) of the replica user pool.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a replica user pool, including Region, status, role, and ARN.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolTaggingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user pool tag can't be set or updated.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UserPoolTagsListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#TagKeysType" } }, "com.amazonaws.cognitoidentityprovider#UserPoolTagsType": { "type": "map", "key": { "target": "com.amazonaws.cognitoidentityprovider#TagKeysType" }, "value": { "target": "com.amazonaws.cognitoidentityprovider#TagValueType" } }, "com.amazonaws.cognitoidentityprovider#UserPoolTierType": { "type": "enum", "members": { "LITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LITE" } }, "ESSENTIALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ESSENTIALS" } }, "PLUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLUS" } } } }, "com.amazonaws.cognitoidentityprovider#UserPoolTokenSessionConfigType": { "type": "structure", "members": { "MaxPerUser": { "target": "com.amazonaws.cognitoidentityprovider#MaxSessionsPerUserType", "traits": { "smithy.api#documentation": "The maximum number of active token sessions that a user can have across the user\n pool. The minimum value is 1 and the maximum value is 100. The\n default is 20. When a user reaches this limit, the next successful\n authentication automatically evicts that user's least recently used token session before\n it creates the new session. Lowering this value doesn't evict existing sessions on its\n own; the user is brought back within the limit on their next sign-in.
The pool-wide token session settings for a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#UserPoolType": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolIdType", "traits": { "smithy.api#documentation": "The ID of the user pool.
" } }, "Name": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolNameType", "traits": { "smithy.api#documentation": "The name of the user pool.
" } }, "Policies": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolPolicyType", "traits": { "smithy.api#documentation": "A list of user pool policies. Contains the policy that sets password-complexity\n requirements.
" } }, "DeletionProtection": { "target": "com.amazonaws.cognitoidentityprovider#DeletionProtectionType", "traits": { "smithy.api#documentation": "When active, DeletionProtection prevents accidental deletion of your user\npool. Before you can delete a user pool that you have protected against deletion, you\nmust deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request, \nAmazon Cognito returns an InvalidParameterException error. To delete a protected user pool, \nsend a new DeleteUserPool request after you deactivate deletion protection in an \nUpdateUserPool API request.
A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible\n stages of user pool operations. Triggers can modify the outcome of the operations that\n invoked them.
" } }, "Status": { "target": "com.amazonaws.cognitoidentityprovider#StatusType", "traits": { "smithy.api#deprecated": { "message": "This property is no longer available." }, "smithy.api#documentation": "This parameter is no longer used.
" } }, "LastModifiedDate": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
A list of the user attributes and their properties in your user pool. The attribute\n schema contains standard attributes, custom attributes with a custom:\n prefix, and developer attributes with a dev: prefix. For more information,\n see User pool\n attributes.
Developer-only attributes are a legacy feature of user pools, and are read-only to all\n app clients. You can create and update developer-only attributes only with\n IAM-authenticated API operations. Use app client read/write permissions instead.
" } }, "AutoVerifiedAttributes": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType", "traits": { "smithy.api#documentation": "The attributes that are auto-verified in a user pool.
" } }, "AliasAttributes": { "target": "com.amazonaws.cognitoidentityprovider#AliasAttributesListType", "traits": { "smithy.api#documentation": "Attributes supported as an alias for this user pool. An alias is an attribute that\n users can enter as an alternative username. Possible values: phone_number, email, or preferred_username.
" } }, "UsernameAttributes": { "target": "com.amazonaws.cognitoidentityprovider#UsernameAttributesListType", "traits": { "smithy.api#documentation": "Specifies whether a user can use an email address or phone number as a username when\n they sign up.
" } }, "SmsVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { "smithy.api#documentation": "This parameter is no longer used.
" } }, "VerificationMessageTemplate": { "target": "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType", "traits": { "smithy.api#documentation": "The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.
" } }, "SmsAuthenticationMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { "smithy.api#documentation": "The contents of the SMS authentication message.
" } }, "UserAttributeUpdateSettings": { "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", "traits": { "smithy.api#documentation": "The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to email addresses and phone numbers.
Can be one of the following values:
\n\n OFF - MFA tokens aren't required and can't be specified during user\n registration.
\n ON - MFA tokens are required for all user registrations. You can\n only specify required when you're initially creating a user pool.
\n OPTIONAL - Users have the option when registering to create an MFA\n token.
The device-remembering configuration for a user pool. A null value indicates that you\n have deactivated device remembering in your user pool.
\nWhen you provide a value for any DeviceConfiguration field, you\n activate the Amazon Cognito device-remembering feature.
A number estimating the size of the user pool.
" } }, "EmailConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#EmailConfigurationType", "traits": { "smithy.api#documentation": "The email configuration of your user pool. The email configuration type sets your\n preferred sending method, Amazon Web Services Region, and sender for messages from your user\n pool.
" } }, "SmsConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#SmsConfigurationType", "traits": { "smithy.api#documentation": "User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS\n messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an\n Identity and Access Management (IAM) role in your Amazon Web Services account.
" } }, "UserPoolTags": { "target": "com.amazonaws.cognitoidentityprovider#UserPoolTagsType", "traits": { "smithy.api#documentation": "The tags that are assigned to the user pool. A tag is a label that you can apply to\n user pools to categorize and manage them in different ways, such as by purpose, owner,\n environment, or other criteria.
" } }, "SmsConfigurationFailure": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The reason why the SMS configuration can't send the messages to your users.
\nThis message might include comma-separated values to describe why your SMS\n configuration can't send messages to user pool end users.
\nThe Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly\n configured. For more information, see SmsConfigurationType.
\nThe Amazon Web Services account is in the SNS SMS Sandbox and messages will\n only reach verified end users. This parameter won\u2019t get populated with\n SNSSandbox if the user creating the user pool doesn\u2019t have SNS permissions.\n To learn how to move your Amazon Web Services account out of the sandbox, see\n Moving out\n of the SMS sandbox.
\nDeprecated. Review error codes from API requests with\n EventSource:cognito-idp.amazonaws.com in CloudTrail for\n information about problems with user pool email configuration.
The domain prefix, if the user pool has a domain associated with it.
" } }, "CustomDomain": { "target": "com.amazonaws.cognitoidentityprovider#DomainType", "traits": { "smithy.api#documentation": "A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use\n a custom domain to host the sign-up and sign-in pages for your application. An example\n of a custom domain name might be auth.example.com.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
" } }, "AdminCreateUserConfig": { "target": "com.amazonaws.cognitoidentityprovider#AdminCreateUserConfigType", "traits": { "smithy.api#documentation": "The configuration for AdminCreateUser requests.
Contains settings for activation of threat protection, including the operating \nmode and additional authentication types. To log user security information but take \nno action, set to AUDIT. To configure automatic security responses to \npotentially unwanted traffic to your user pool, set to ENFORCED.
For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the \n Plus tier.
" } }, "DcrConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#DcrConfigurationType", "traits": { "smithy.api#documentation": "The dynamic client registration configuration for the user pool. With dynamic client\n registration, applications can register their own app clients at runtime through the\n registration endpoint of your user pool domain. To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } }, "UsernameConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType", "traits": { "smithy.api#documentation": "Case sensitivity of the username input for the selected sign-in option. When case\n sensitivity is set to False (case insensitive), users can sign in with any\n combination of capital and lowercase letters. For example, username,\n USERNAME, or UserName, or for email,\n email@example.com or EMaiL@eXamplE.Com. For most use\n cases, set case sensitivity to False (case insensitive) as a best practice.\n When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in\n case as the same user, and prevents a case variation from being assigned to the same\n attribute for a different user.
The Amazon Resource Name (ARN) of the user pool.
" } }, "AccountRecoverySetting": { "target": "com.amazonaws.cognitoidentityprovider#AccountRecoverySettingType", "traits": { "smithy.api#documentation": "The available verified method a user can use to recover their password when they call\n ForgotPassword. You can use this setting to define a preferred method\n when a user has more than one method available. With this setting, SMS doesn't qualify\n for a valid password recovery mechanism if the user also has SMS multi-factor\n authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy\n behavior to determine the recovery method where SMS is preferred through email.
The user pool feature plan, or tier. This parameter determines the\n eligibility of the user pool for features like managed login, access-token\n customization, and threat protection. Defaults to ESSENTIALS.
The key configuration for the user pool, including encryption settings.
" } }, "IssuerConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#IssuerConfigurationType", "traits": { "smithy.api#documentation": "The issuer configuration for the user pool, including token issuing settings.
" } }, "AcrConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#AcrConfigurationType", "traits": { "smithy.api#documentation": "The names of the authentication context class reference (ACR) levels for the user\n pool. Amazon Cognito always returns the effective configuration, with default names\n merged in for any level that you haven't customized.
\nConfiguring custom ACR level names requires the Essentials or Plus feature plan.\n To activate this setting, your user pool must be in the \n Essentials tier or higher.
" } } }, "traits": { "smithy.api#documentation": "The configuration of a user pool.
" } }, "com.amazonaws.cognitoidentityprovider#UserSessionTrackingType": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.cognitoidentityprovider#UserStatusType": { "type": "enum", "members": { "UNCONFIRMED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNCONFIRMED" } }, "CONFIRMED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONFIRMED" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } }, "COMPROMISED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPROMISED" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } }, "RESET_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESET_REQUIRED" } }, "FORCE_CHANGE_PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FORCE_CHANGE_PASSWORD" } }, "EXTERNAL_PROVIDER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXTERNAL_PROVIDER" } } } }, "com.amazonaws.cognitoidentityprovider#UserType": { "type": "structure", "members": { "Username": { "target": "com.amazonaws.cognitoidentityprovider#UsernameType", "traits": { "smithy.api#documentation": "The user's username.
" } }, "Attributes": { "target": "com.amazonaws.cognitoidentityprovider#AttributeListType", "traits": { "smithy.api#documentation": "Names and values of a user's attributes, for example email.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
Indicates whether the user's account is enabled or disabled.
" } }, "UserStatus": { "target": "com.amazonaws.cognitoidentityprovider#UserStatusType", "traits": { "smithy.api#documentation": "The user status. This can be one of the following:
\n\n UNCONFIRMED: User has been created but not confirmed.
\n CONFIRMED: User has been confirmed.
\n EXTERNAL_PROVIDER: User signed in with a third-party IdP.
\n RESET_REQUIRED: User is confirmed, but the user must request a\n code and reset their password before they can sign in.
\n FORCE_CHANGE_PASSWORD: The user is confirmed and the user can\n sign in using a temporary password, but on first sign-in, the user must change\n their password to a new value before doing anything else.
The statuses ARCHIVED, UNKNOWN, and COMPROMISED\n are no longer used.
The user's MFA configuration.
" } } }, "traits": { "smithy.api#documentation": "A user profile in a Amazon Cognito user pool.
" } }, "com.amazonaws.cognitoidentityprovider#UserVerificationType": { "type": "enum", "members": { "REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "required" } }, "PREFERRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "preferred" } } } }, "com.amazonaws.cognitoidentityprovider#UsernameAttributeType": { "type": "enum", "members": { "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "phone_number" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "email" } } } }, "com.amazonaws.cognitoidentityprovider#UsernameAttributesListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#UsernameAttributeType" } }, "com.amazonaws.cognitoidentityprovider#UsernameConfigurationType": { "type": "structure", "members": { "CaseSensitive": { "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", "traits": { "smithy.api#documentation": "Specifies whether user name case sensitivity will be applied for all users in the user\n pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False\n (case insensitive) as a best practice. When usernames and email addresses are case\n insensitive, users can sign in as the same user when they enter a different\n capitalization of their user name.
Valid values include:
\nEnables case sensitivity for all username input. When this option is set\n to true, users must sign in using the exact capitalization of\n their given username, such as \u201cUserName\u201d. This is the default value.
Enables case insensitivity for all username input. For example, when this\n option is set to false, users can sign in using\n username, USERNAME, or UserName.\n This option also enables both preferred_username and\n email alias to be case insensitive, in addition to the\n username attribute.
The configuration of a user pool for username case sensitivity.
" } }, "com.amazonaws.cognitoidentityprovider#UsernameExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType", "traits": { "smithy.api#documentation": "The message returned when Amazon Cognito throws a user name exists exception.
" } } }, "traits": { "smithy.api#documentation": "This exception is thrown when Amazon Cognito encounters a user name that already\n exists in the user pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#UsernameType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#UsersListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#UserType" } }, "com.amazonaws.cognitoidentityprovider#VerificationMessageTemplateType": { "type": "structure", "members": { "SmsMessage": { "target": "com.amazonaws.cognitoidentityprovider#SmsVerificationMessageType", "traits": { "smithy.api#documentation": "The template for SMS messages that Amazon Cognito sends to your users.
" } }, "EmailMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { "smithy.api#documentation": "The template for email messages that Amazon Cognito sends to your users. You can set an\n EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email\n messages with your own Amazon SES configuration.
The subject line for the email message template. You can set an\n EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email\n messages with your own Amazon SES configuration.
The email message template for sending a confirmation link to the user. You can set an\n EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email\n messages with your own Amazon SES configuration.
The subject line for the email message template for sending a confirmation link to the\n user. You can set an EmailSubjectByLink template only if the value of\n EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email\n messages with your own Amazon SES configuration.
The configuration of verification emails to contain a clickable link or a verification\n code.
\nFor link, your template body must contain link text in the format {##Click\n here##}. \"Click here\" in the example is a customizable string. For code, your\n template body must contain a code placeholder in the format {####}.
The template for the verification message that your user pool delivers to users who\n set an email address or phone number attribute.
" } }, "com.amazonaws.cognitoidentityprovider#VerifiedAttributeType": { "type": "enum", "members": { "PHONE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "phone_number" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "email" } } } }, "com.amazonaws.cognitoidentityprovider#VerifiedAttributesListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#VerifiedAttributeType" } }, "com.amazonaws.cognitoidentityprovider#VerifySoftwareToken": { "type": "operation", "input": { "target": "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenRequest" }, "output": { "target": "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenResponse" }, "errors": [ { "target": "com.amazonaws.cognitoidentityprovider#CodeMismatchException" }, { "target": "com.amazonaws.cognitoidentityprovider#EnableSoftwareTokenMFAException" }, { "target": "com.amazonaws.cognitoidentityprovider#ForbiddenException" }, { "target": "com.amazonaws.cognitoidentityprovider#InternalErrorException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidParameterException" }, { "target": "com.amazonaws.cognitoidentityprovider#InvalidUserPoolConfigurationException" }, { "target": "com.amazonaws.cognitoidentityprovider#NotAuthorizedException" }, { "target": "com.amazonaws.cognitoidentityprovider#OperationNotEnabledException" }, { "target": "com.amazonaws.cognitoidentityprovider#PasswordResetRequiredException" }, { "target": "com.amazonaws.cognitoidentityprovider#ResourceNotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#SoftwareTokenMFANotFoundException" }, { "target": "com.amazonaws.cognitoidentityprovider#TooManyRequestsException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotConfirmedException" }, { "target": "com.amazonaws.cognitoidentityprovider#UserNotFoundException" } ], "traits": { "smithy.api#auth": [], "smithy.api#documentation": "Registers the current user's time-based one-time password (TOTP) authenticator\n with a code generated in their authenticator app from a private key that's supplied\n by your user pool. Marks the user's software token MFA status as \"verified\" if\n successful. The request takes an access token or a session string, but not both.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The session ID from an AssociateSoftwareToken request.
A TOTP that the user generated in their configured authenticator app.
", "smithy.api#required": {} } }, "FriendlyDeviceName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "A friendly name for the device that's running the TOTP authenticator.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.cognitoidentityprovider#VerifySoftwareTokenResponseType", "traits": { "smithy.api#documentation": "Amazon Cognito can accept or reject the code that you provide. This response parameter\n indicates the success of TOTP verification. Some reasons that this operation might\n return an error are clock skew on the user's device and excessive retries.
" } }, "Session": { "target": "com.amazonaws.cognitoidentityprovider#SessionType", "traits": { "smithy.api#documentation": "This session ID satisfies an MFA_SETUP challenge. Supply the session ID\n in your challenge response.
Submits a verification code for a signed-in user who has added or changed a value of\n an auto-verified attribute. When successful, the user's attribute becomes verified\n and the attribute email_verified or phone_number_verified\n becomes true.
If your user pool requires verification before Amazon Cognito updates the attribute value,\n this operation updates the affected attribute to its pending value.
\nAuthorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
\nA valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for \naws.cognito.signin.user.admin.
The name of the attribute that you want to verify.
", "smithy.api#required": {} } }, "Code": { "target": "com.amazonaws.cognitoidentityprovider#ConfirmationCodeType", "traits": { "smithy.api#documentation": "The verification code that your user pool sent to the added or changed attribute, for\n example the user's email address.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the request to verify user attributes.
", "smithy.api#input": {} } }, "com.amazonaws.cognitoidentityprovider#VerifyUserAttributeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "A container representing the response from the server from the request to verify user\n attributes.
", "smithy.api#output": {} } }, "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorAttachmentType": { "type": "string" }, "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportType": { "type": "string" }, "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportsList": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportType" } }, "com.amazonaws.cognitoidentityprovider#WebAuthnChallengeNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the challenge from StartWebAuthn\n registration has expired.
This exception is thrown when the access token is for a different client than the one\n in the original StartWebAuthnRegistration request.
This exception is thrown when a user pool doesn't have a configured relying party\n id or a user pool domain.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#WebAuthnConfigurationType": { "type": "structure", "members": { "RelyingPartyId": { "target": "com.amazonaws.cognitoidentityprovider#RelyingPartyIdType", "traits": { "smithy.api#documentation": "Sets or displays the authentication domain, typically your user pool domain, that\n passkey providers must use as a relying party (RP) in their configuration.
\nUnder the following conditions, the passkey relying party ID must be the\n fully-qualified domain name of your custom domain:
\nThe user pool is configured for passkey authentication.
\nThe user pool has a custom domain, whether or not it also has a prefix\n domain.
\nYour application performs authentication with managed login or the classic\n hosted UI.
\nWhen required, users can only register and sign in users with passkeys\n that are capable of user\n verification. When preferred, your user pool doesn't\n require the use of authenticators with user verification but encourages it.
Sets whether passkeys can be used as multi-factor authentication (MFA). When set to\n MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user\n verification satisfies MFA requirements. When set to SINGLE_FACTOR or not\n set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the \n Essentials tier or higher.
Settings for authentication (MFA) with passkey, or webauthN, biometric and\n security-key devices in a user pool. Configures the following:
\nConfiguration for requiring user-verification support in passkeys.
\nThe user pool relying-party ID. This is the domain, typically your user pool\n domain, that user's passkey providers should trust as a receiver of passkey\n authentication.
\nThe providers that you want to allow as origins for passkey\n authentication.
\nThe unique identifier of the passkey credential.
", "smithy.api#required": {} } }, "FriendlyCredentialName": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "An automatically-generated friendly name for the passkey credential.
", "smithy.api#required": {} } }, "RelyingPartyId": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { "smithy.api#documentation": "The relying-party ID of the provider for the passkey credential.
", "smithy.api#required": {} } }, "AuthenticatorAttachment": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorAttachmentType", "traits": { "smithy.api#documentation": "The general category of the passkey authenticator. Can be a platform, or on-device\n authenticator like a built-in fingerprint scanner, or a cross-platform device that's not\n attached to the device like a Bluetooth security key.
" } }, "AuthenticatorTransports": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnAuthenticatorTransportsList", "traits": { "smithy.api#documentation": "Information about the transport methods of the passkey credential, for example USB or\n Bluetooth Low Energy.
", "smithy.api#required": {} } }, "CreatedAt": { "target": "com.amazonaws.cognitoidentityprovider#DateType", "traits": { "smithy.api#documentation": "The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a \nhuman-readable format like ISO 8601 or a Java Date object.
The details of a passkey, or webauthN, biometric or security-key authentication factor\n for a user.
" } }, "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescriptionListType": { "type": "list", "member": { "target": "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialDescription" } }, "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialNotSupportedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when a user presents passkey credentials from an unsupported\n device or provider.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#WebAuthnCredentialsQueryLimitType": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 20 } } }, "com.amazonaws.cognitoidentityprovider#WebAuthnFactorConfigurationType": { "type": "enum", "members": { "SINGLE_FACTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SINGLE_FACTOR" } }, "MULTI_FACTOR_WITH_USER_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MULTI_FACTOR_WITH_USER_VERIFICATION" } } }, "traits": { "smithy.api#documentation": "The configuration of passkey authentication as a single factor or a multi-factor\n authentication (MFA) method. When set to\n MULTI_FACTOR_WITH_USER_VERIFICATION, your user pool requires passkey\n authenticators to perform user\n verification, for example a biometric or PIN. User verification combined\n with the passkey constitutes multi-factor authentication. When set to\n SINGLE_FACTOR, passkeys are a single authentication factor.
Specifies whether passkey MFA is activated for a user. When activated, the user's\n passkey authentication requires user verification, and passkey sign-in is available\n when MFA is required. The user must also have at least one other MFA method such as\n SMS, TOTP, or email activated to prevent account lockout.
" } } }, "traits": { "smithy.api#documentation": "A user's preference for using passkey, or WebAuthn, multi-factor authentication\n (MFA). Turns passkey MFA on and off for the user. Unlike other MFA settings types,\n this type doesn't include a PreferredMfa option because passkey MFA\n applies only when passkey is the first authentication factor.
This exception is thrown when the passkey feature isn't enabled for the user\n pool.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#WebAuthnOriginNotAllowedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the passkey credential's registration origin does not\n align with the user pool relying party id.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#WebAuthnRelyingPartyMismatchException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.cognitoidentityprovider#MessageType" } }, "traits": { "smithy.api#documentation": "This exception is thrown when the given passkey credential is associated with a\n different relying party ID than the user pool relying party ID.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.cognitoidentityprovider#WrappedBooleanType": { "type": "boolean" }, "com.amazonaws.cognitoidentityprovider#WrappedIntegerType": { "type": "integer" } } }