{ "version": "2.0", "metadata": { "apiVersion": "2016-04-18", "endpointPrefix": "cognito-idp", "jsonVersion": "1.1", "protocol": "json", "serviceFullName": "Amazon Cognito Identity Provider", "signatureVersion": "v4", "targetPrefix": "AWSCognitoIdentityProviderService" }, "operations": { "AddCustomAttributes": { "input": { "type": "structure", "required": [ "UserPoolId", "CustomAttributes" ], "members": { "UserPoolId": {}, "CustomAttributes": { "type": "list", "member": { "shape": "S4" } } } }, "output": { "type": "structure", "members": {} } }, "AdminConfirmSignUp": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": {} } }, "AdminDeleteUser": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } } }, "AdminDeleteUserAttributes": { "input": { "type": "structure", "required": [ "UserPoolId", "Username", "UserAttributeNames" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" }, "UserAttributeNames": { "shape": "Sh" } } }, "output": { "type": "structure", "members": {} } }, "AdminDisableUser": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": {} } }, "AdminEnableUser": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": {} } }, "AdminForgetDevice": { "input": { "type": "structure", "required": [ "UserPoolId", "Username", "DeviceKey" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" }, "DeviceKey": {} } } }, "AdminGetDevice": { "input": { "type": "structure", "required": [ "DeviceKey", "UserPoolId", "Username" ], "members": { "DeviceKey": {}, "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "required": [ "Device" ], "members": { "Device": { "shape": "Ss" } } } }, "AdminGetUser": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "required": [ "Username" ], "members": { "Username": { "shape": "Sd" }, "UserAttributes": { "shape": "St" }, "UserCreateDate": { "type": "timestamp" }, "UserLastModifiedDate": { "type": "timestamp" }, "Enabled": { "type": "boolean" }, "UserStatus": {}, "MFAOptions": { "shape": "S10" } } } }, "AdminInitiateAuth": { "input": { "type": "structure", "required": [ "UserPoolId", "ClientId", "AuthFlow" ], "members": { "UserPoolId": {}, "ClientId": { "shape": "S14" }, "AuthFlow": {}, "AuthParameters": { "shape": "S16" }, "ClientMetadata": { "shape": "S17" } } }, "output": { "type": "structure", "members": { "ChallengeName": {}, "Session": {}, "ChallengeParameters": { "shape": "S1b" }, "AuthenticationResult": { "shape": "S1c" } } } }, "AdminListDevices": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" }, "Limit": { "type": "integer" }, "PaginationToken": {} } }, "output": { "type": "structure", "members": { "Devices": { "shape": "S1k" }, "PaginationToken": {} } } }, "AdminResetUserPassword": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": {} } }, "AdminRespondToAuthChallenge": { "input": { "type": "structure", "required": [ "UserPoolId", "ClientId", "ChallengeName" ], "members": { "UserPoolId": {}, "ClientId": { "shape": "S14" }, "ChallengeName": {}, "ChallengeResponses": { "shape": "S1o" }, "Session": {} } }, "output": { "type": "structure", "members": { "ChallengeName": {}, "Session": {}, "ChallengeParameters": { "shape": "S1b" }, "AuthenticationResult": { "shape": "S1c" } } } }, "AdminSetUserSettings": { "input": { "type": "structure", "required": [ "UserPoolId", "Username", "MFAOptions" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" }, "MFAOptions": { "shape": "S10" } } }, "output": { "type": "structure", "members": {} } }, "AdminUpdateDeviceStatus": { "input": { "type": "structure", "required": [ "UserPoolId", "Username", "DeviceKey" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" }, "DeviceKey": {}, "DeviceRememberedStatus": {} } }, "output": { "type": "structure", "members": {} } }, "AdminUpdateUserAttributes": { "input": { "type": "structure", "required": [ "UserPoolId", "Username", "UserAttributes" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" }, "UserAttributes": { "shape": "St" } } }, "output": { "type": "structure", "members": {} } }, "AdminUserGlobalSignOut": { "input": { "type": "structure", "required": [ "UserPoolId", "Username" ], "members": { "UserPoolId": {}, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": {} } }, "ChangePassword": { "input": { "type": "structure", "required": [ "PreviousPassword", "ProposedPassword" ], "members": { "PreviousPassword": { "shape": "S20" }, "ProposedPassword": { "shape": "S20" }, "AccessToken": { "shape": "S1d" } } }, "output": { "type": "structure", "members": {} }, "authtype": "none" }, "ConfirmDevice": { "input": { "type": "structure", "required": [ "AccessToken", "DeviceKey" ], "members": { "AccessToken": { "shape": "S1d" }, "DeviceKey": {}, "DeviceSecretVerifierConfig": { "type": "structure", "members": { "PasswordVerifier": {}, "Salt": {} } }, "DeviceName": {} } }, "output": { "type": "structure", "members": { "UserConfirmationNecessary": { "type": "boolean" } } } }, "ConfirmForgotPassword": { "input": { "type": "structure", "required": [ "ClientId", "Username", "ConfirmationCode", "Password" ], "members": { "ClientId": { "shape": "S14" }, "SecretHash": { "shape": "S27" }, "Username": { "shape": "Sd" }, "ConfirmationCode": {}, "Password": { "shape": "S20" } } }, "output": { "type": "structure", "members": {} }, "authtype": "none" }, "ConfirmSignUp": { "input": { "type": "structure", "required": [ "ClientId", "Username", "ConfirmationCode" ], "members": { "ClientId": { "shape": "S14" }, "SecretHash": { "shape": "S27" }, "Username": { "shape": "Sd" }, "ConfirmationCode": {}, "ForceAliasCreation": { "type": "boolean" } } }, "output": { "type": "structure", "members": {} }, "authtype": "none" }, "CreateUserPool": { "input": { "type": "structure", "required": [ "PoolName" ], "members": { "PoolName": {}, "Policies": { "shape": "S2f" }, "LambdaConfig": { "shape": "S2i" }, "AutoVerifiedAttributes": { "shape": "S2k" }, "AliasAttributes": { "shape": "S2m" }, "SmsVerificationMessage": {}, "EmailVerificationMessage": {}, "EmailVerificationSubject": {}, "SmsAuthenticationMessage": {}, "MfaConfiguration": {}, "DeviceConfiguration": { "shape": "S2s" }, "EmailConfiguration": { "shape": "S2t" }, "SmsConfiguration": { "shape": "S2v" } } }, "output": { "type": "structure", "members": { "UserPool": { "shape": "S2x" } } } }, "CreateUserPoolClient": { "input": { "type": "structure", "required": [ "UserPoolId", "ClientName" ], "members": { "UserPoolId": {}, "ClientName": {}, "GenerateSecret": { "type": "boolean" }, "RefreshTokenValidity": { "type": "integer" }, "ReadAttributes": { "shape": "S34" }, "WriteAttributes": { "shape": "S34" }, "ExplicitAuthFlows": { "shape": "S36" } } }, "output": { "type": "structure", "members": { "UserPoolClient": { "shape": "S39" } } } }, "DeleteUser": { "input": { "type": "structure", "members": { "AccessToken": { "shape": "S1d" } } }, "authtype": "none" }, "DeleteUserAttributes": { "input": { "type": "structure", "required": [ "UserAttributeNames" ], "members": { "UserAttributeNames": { "shape": "Sh" }, "AccessToken": { "shape": "S1d" } } }, "output": { "type": "structure", "members": {} }, "authtype": "none" }, "DeleteUserPool": { "input": { "type": "structure", "required": [ "UserPoolId" ], "members": { "UserPoolId": {} } } }, "DeleteUserPoolClient": { "input": { "type": "structure", "required": [ "UserPoolId", "ClientId" ], "members": { "UserPoolId": {}, "ClientId": { "shape": "S14" } } } }, "DescribeUserPool": { "input": { "type": "structure", "required": [ "UserPoolId" ], "members": { "UserPoolId": {} } }, "output": { "type": "structure", "members": { "UserPool": { "shape": "S2x" } } } }, "DescribeUserPoolClient": { "input": { "type": "structure", "required": [ "UserPoolId", "ClientId" ], "members": { "UserPoolId": {}, "ClientId": { "shape": "S14" } } }, "output": { "type": "structure", "members": { "UserPoolClient": { "shape": "S39" } } } }, "ForgetDevice": { "input": { "type": "structure", "required": [ "DeviceKey" ], "members": { "AccessToken": { "shape": "S1d" }, "DeviceKey": {} } } }, "ForgotPassword": { "input": { "type": "structure", "required": [ "ClientId", "Username" ], "members": { "ClientId": { "shape": "S14" }, "SecretHash": { "shape": "S27" }, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": { "CodeDeliveryDetails": { "shape": "S3n" } } }, "authtype": "none" }, "GetDevice": { "input": { "type": "structure", "required": [ "DeviceKey" ], "members": { "DeviceKey": {}, "AccessToken": { "shape": "S1d" } } }, "output": { "type": "structure", "required": [ "Device" ], "members": { "Device": { "shape": "Ss" } } } }, "GetUser": { "input": { "type": "structure", "members": { "AccessToken": { "shape": "S1d" } } }, "output": { "type": "structure", "required": [ "Username", "UserAttributes" ], "members": { "Username": { "shape": "Sd" }, "UserAttributes": { "shape": "St" }, "MFAOptions": { "shape": "S10" } } }, "authtype": "none" }, "GetUserAttributeVerificationCode": { "input": { "type": "structure", "required": [ "AttributeName" ], "members": { "AccessToken": { "shape": "S1d" }, "AttributeName": {} } }, "output": { "type": "structure", "members": { "CodeDeliveryDetails": { "shape": "S3n" } } }, "authtype": "none" }, "GlobalSignOut": { "input": { "type": "structure", "members": { "AccessToken": { "shape": "S1d" } } }, "output": { "type": "structure", "members": {} } }, "InitiateAuth": { "input": { "type": "structure", "required": [ "AuthFlow", "ClientId" ], "members": { "AuthFlow": {}, "AuthParameters": { "shape": "S16" }, "ClientMetadata": { "shape": "S17" }, "ClientId": { "shape": "S14" } } }, "output": { "type": "structure", "members": { "ChallengeName": {}, "Session": {}, "ChallengeParameters": { "shape": "S1b" }, "AuthenticationResult": { "shape": "S1c" } } } }, "ListDevices": { "input": { "type": "structure", "required": [ "AccessToken" ], "members": { "AccessToken": { "shape": "S1d" }, "Limit": { "type": "integer" }, "PaginationToken": {} } }, "output": { "type": "structure", "members": { "Devices": { "shape": "S1k" }, "PaginationToken": {} } } }, "ListUserPoolClients": { "input": { "type": "structure", "required": [ "UserPoolId" ], "members": { "UserPoolId": {}, "MaxResults": { "type": "integer" }, "NextToken": {} } }, "output": { "type": "structure", "members": { "UserPoolClients": { "type": "list", "member": { "type": "structure", "members": { "ClientId": { "shape": "S14" }, "UserPoolId": {}, "ClientName": {} } } }, "NextToken": {} } } }, "ListUserPools": { "input": { "type": "structure", "required": [ "MaxResults" ], "members": { "NextToken": {}, "MaxResults": { "type": "integer" } } }, "output": { "type": "structure", "members": { "UserPools": { "type": "list", "member": { "type": "structure", "members": { "Id": {}, "Name": {}, "LambdaConfig": { "shape": "S2i" }, "Status": {}, "LastModifiedDate": { "type": "timestamp" }, "CreationDate": { "type": "timestamp" } } } }, "NextToken": {} } } }, "ListUsers": { "input": { "type": "structure", "required": [ "UserPoolId" ], "members": { "UserPoolId": {}, "AttributesToGet": { "type": "list", "member": {} }, "Limit": { "type": "integer" }, "PaginationToken": {}, "Filter": {} } }, "output": { "type": "structure", "members": { "Users": { "type": "list", "member": { "type": "structure", "members": { "Username": { "shape": "Sd" }, "Attributes": { "shape": "St" }, "UserCreateDate": { "type": "timestamp" }, "UserLastModifiedDate": { "type": "timestamp" }, "Enabled": { "type": "boolean" }, "UserStatus": {} } } }, "PaginationToken": {} } } }, "ResendConfirmationCode": { "input": { "type": "structure", "required": [ "ClientId", "Username" ], "members": { "ClientId": { "shape": "S14" }, "SecretHash": { "shape": "S27" }, "Username": { "shape": "Sd" } } }, "output": { "type": "structure", "members": { "CodeDeliveryDetails": { "shape": "S3n" } } }, "authtype": "none" }, "RespondToAuthChallenge": { "input": { "type": "structure", "required": [ "ClientId", "ChallengeName" ], "members": { "ClientId": { "shape": "S14" }, "ChallengeName": {}, "Session": {}, "ChallengeResponses": { "shape": "S1o" } } }, "output": { "type": "structure", "members": { "ChallengeName": {}, "Session": {}, "ChallengeParameters": { "shape": "S1b" }, "AuthenticationResult": { "shape": "S1c" } } } }, "SetUserSettings": { "input": { "type": "structure", "required": [ "AccessToken", "MFAOptions" ], "members": { "AccessToken": { "shape": "S1d" }, "MFAOptions": { "shape": "S10" } } }, "output": { "type": "structure", "members": {} }, "authtype": "none" }, "SignUp": { "input": { "type": "structure", "required": [ "ClientId", "Username", "Password" ], "members": { "ClientId": { "shape": "S14" }, "SecretHash": { "shape": "S27" }, "Username": { "shape": "Sd" }, "Password": { "shape": "S20" }, "UserAttributes": { "shape": "St" }, "ValidationData": { "shape": "St" } } }, "output": { "type": "structure", "members": { "UserConfirmed": { "type": "boolean" }, "CodeDeliveryDetails": { "shape": "S3n" } } }, "authtype": "none" }, "UpdateDeviceStatus": { "input": { "type": "structure", "required": [ "AccessToken", "DeviceKey" ], "members": { "AccessToken": { "shape": "S1d" }, "DeviceKey": {}, "DeviceRememberedStatus": {} } }, "output": { "type": "structure", "members": {} } }, "UpdateUserAttributes": { "input": { "type": "structure", "required": [ "UserAttributes" ], "members": { "UserAttributes": { "shape": "St" }, "AccessToken": { "shape": "S1d" } } }, "output": { "type": "structure", "members": { "CodeDeliveryDetailsList": { "type": "list", "member": { "shape": "S3n" } } } }, "authtype": "none" }, "UpdateUserPool": { "input": { "type": "structure", "required": [ "UserPoolId" ], "members": { "UserPoolId": {}, "Policies": { "shape": "S2f" }, "LambdaConfig": { "shape": "S2i" }, "AutoVerifiedAttributes": { "shape": "S2k" }, "SmsVerificationMessage": {}, "EmailVerificationMessage": {}, "EmailVerificationSubject": {}, "SmsAuthenticationMessage": {}, "MfaConfiguration": {}, "DeviceConfiguration": { "shape": "S2s" }, "EmailConfiguration": { "shape": "S2t" }, "SmsConfiguration": { "shape": "S2v" } } }, "output": { "type": "structure", "members": {} } }, "UpdateUserPoolClient": { "input": { "type": "structure", "required": [ "UserPoolId", "ClientId" ], "members": { "UserPoolId": {}, "ClientId": { "shape": "S14" }, "ClientName": {}, "RefreshTokenValidity": { "type": "integer" }, "ReadAttributes": { "shape": "S34" }, "WriteAttributes": { "shape": "S34" }, "ExplicitAuthFlows": { "shape": "S36" } } }, "output": { "type": "structure", "members": { "UserPoolClient": { "shape": "S39" } } } }, "VerifyUserAttribute": { "input": { "type": "structure", "required": [ "AttributeName", "Code" ], "members": { "AccessToken": { "shape": "S1d" }, "AttributeName": {}, "Code": {} } }, "output": { "type": "structure", "members": {} }, "authtype": "none" } }, "shapes": { "S4": { "type": "structure", "members": { "Name": {}, "AttributeDataType": {}, "DeveloperOnlyAttribute": { "type": "boolean" }, "Mutable": { "type": "boolean" }, "Required": { "type": "boolean" }, "NumberAttributeConstraints": { "type": "structure", "members": { "MinValue": {}, "MaxValue": {} } }, "StringAttributeConstraints": { "type": "structure", "members": { "MinLength": {}, "MaxLength": {} } } } }, "Sd": { "type": "string", "sensitive": true }, "Sh": { "type": "list", "member": {} }, "Ss": { "type": "structure", "members": { "DeviceKey": {}, "DeviceAttributes": { "shape": "St" }, "DeviceCreateDate": { "type": "timestamp" }, "DeviceLastModifiedDate": { "type": "timestamp" }, "DeviceLastAuthenticatedDate": { "type": "timestamp" } } }, "St": { "type": "list", "member": { "type": "structure", "required": [ "Name" ], "members": { "Name": {}, "Value": { "type": "string", "sensitive": true } } } }, "S10": { "type": "list", "member": { "type": "structure", "members": { "DeliveryMedium": {}, "AttributeName": {} } } }, "S14": { "type": "string", "sensitive": true }, "S16": { "type": "map", "key": {}, "value": {} }, "S17": { "type": "map", "key": {}, "value": {} }, "S1b": { "type": "map", "key": {}, "value": {} }, "S1c": { "type": "structure", "members": { "AccessToken": { "shape": "S1d" }, "ExpiresIn": { "type": "integer" }, "TokenType": {}, "RefreshToken": { "shape": "S1d" }, "IdToken": { "shape": "S1d" }, "NewDeviceMetadata": { "type": "structure", "members": { "DeviceKey": {}, "DeviceGroupKey": {} } } } }, "S1d": { "type": "string", "sensitive": true }, "S1k": { "type": "list", "member": { "shape": "Ss" } }, "S1o": { "type": "map", "key": {}, "value": {} }, "S20": { "type": "string", "sensitive": true }, "S27": { "type": "string", "sensitive": true }, "S2f": { "type": "structure", "members": { "PasswordPolicy": { "type": "structure", "members": { "MinimumLength": { "type": "integer" }, "RequireUppercase": { "type": "boolean" }, "RequireLowercase": { "type": "boolean" }, "RequireNumbers": { "type": "boolean" }, "RequireSymbols": { "type": "boolean" } } } } }, "S2i": { "type": "structure", "members": { "PreSignUp": {}, "CustomMessage": {}, "PostConfirmation": {}, "PreAuthentication": {}, "PostAuthentication": {}, "DefineAuthChallenge": {}, "CreateAuthChallenge": {}, "VerifyAuthChallengeResponse": {} } }, "S2k": { "type": "list", "member": {} }, "S2m": { "type": "list", "member": {} }, "S2s": { "type": "structure", "members": { "ChallengeRequiredOnNewDevice": { "type": "boolean" }, "DeviceOnlyRememberedOnUserPrompt": { "type": "boolean" } } }, "S2t": { "type": "structure", "members": { "SourceArn": {}, "ReplyToEmailAddress": {} } }, "S2v": { "type": "structure", "members": { "SnsCallerArn": {}, "ExternalId": {} } }, "S2x": { "type": "structure", "members": { "Id": {}, "Name": {}, "Policies": { "shape": "S2f" }, "LambdaConfig": { "shape": "S2i" }, "Status": {}, "LastModifiedDate": { "type": "timestamp" }, "CreationDate": { "type": "timestamp" }, "SchemaAttributes": { "type": "list", "member": { "shape": "S4" } }, "AutoVerifiedAttributes": { "shape": "S2k" }, "AliasAttributes": { "shape": "S2m" }, "SmsVerificationMessage": {}, "EmailVerificationMessage": {}, "EmailVerificationSubject": {}, "SmsAuthenticationMessage": {}, "MfaConfiguration": {}, "DeviceConfiguration": { "shape": "S2s" }, "EstimatedNumberOfUsers": { "type": "integer" }, "EmailConfiguration": { "shape": "S2t" }, "SmsConfiguration": { "shape": "S2v" }, "SmsConfigurationFailure": {}, "EmailConfigurationFailure": {} } }, "S34": { "type": "list", "member": {} }, "S36": { "type": "list", "member": {} }, "S39": { "type": "structure", "members": { "UserPoolId": {}, "ClientName": {}, "ClientId": { "shape": "S14" }, "ClientSecret": { "type": "string", "sensitive": true }, "LastModifiedDate": { "type": "timestamp" }, "CreationDate": { "type": "timestamp" }, "RefreshTokenValidity": { "type": "integer" }, "ReadAttributes": { "shape": "S34" }, "WriteAttributes": { "shape": "S34" }, "ExplicitAuthFlows": { "shape": "S36" } } }, "S3n": { "type": "structure", "members": { "Destination": {}, "DeliveryMedium": {}, "AttributeName": {} } } } }