universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
2,385 lines • 75 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2016-04-18",
"endpointPrefix": "cognito-idp",
"jsonVersion": "1.1",
"protocol": "json",
"serviceFullName": "Amazon Cognito Identity Provider",
"serviceId": "Cognito Identity Provider",
"signatureVersion": "v4",
"targetPrefix": "AWSCognitoIdentityProviderService",
"uid": "cognito-idp-2016-04-18"
},
"operations": {
"AddCustomAttributes": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"CustomAttributes"
],
"members": {
"UserPoolId": {},
"CustomAttributes": {
"type": "list",
"member": {
"shape": "S4"
}
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminAddUserToGroup": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username",
"GroupName"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"GroupName": {}
}
}
},
"AdminConfirmSignUp": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminCreateUser": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"UserAttributes": {
"shape": "Sj"
},
"ValidationData": {
"shape": "Sj"
},
"TemporaryPassword": {
"shape": "Sn"
},
"ForceAliasCreation": {
"type": "boolean"
},
"MessageAction": {},
"DesiredDeliveryMediums": {
"type": "list",
"member": {}
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {
"User": {
"shape": "St"
}
}
}
},
"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": "S10"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminDisableProviderForUser": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"User"
],
"members": {
"UserPoolId": {},
"User": {
"shape": "S13"
}
}
},
"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": "S1e"
}
}
}
},
"AdminGetUser": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
}
}
},
"output": {
"type": "structure",
"required": [
"Username"
],
"members": {
"Username": {
"shape": "Sd"
},
"UserAttributes": {
"shape": "Sj"
},
"UserCreateDate": {
"type": "timestamp"
},
"UserLastModifiedDate": {
"type": "timestamp"
},
"Enabled": {
"type": "boolean"
},
"UserStatus": {},
"MFAOptions": {
"shape": "Sw"
},
"PreferredMfaSetting": {},
"UserMFASettingList": {
"shape": "S1h"
}
}
}
},
"AdminInitiateAuth": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ClientId",
"AuthFlow"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
},
"AuthFlow": {},
"AuthParameters": {
"shape": "S1l"
},
"ClientMetadata": {
"shape": "Sg"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"ContextData": {
"shape": "S1n"
}
}
},
"output": {
"type": "structure",
"members": {
"ChallengeName": {},
"Session": {},
"ChallengeParameters": {
"shape": "S1t"
},
"AuthenticationResult": {
"shape": "S1u"
}
}
}
},
"AdminLinkProviderForUser": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"DestinationUser",
"SourceUser"
],
"members": {
"UserPoolId": {},
"DestinationUser": {
"shape": "S13"
},
"SourceUser": {
"shape": "S13"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminListDevices": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"Limit": {
"type": "integer"
},
"PaginationToken": {}
}
},
"output": {
"type": "structure",
"members": {
"Devices": {
"shape": "S24"
},
"PaginationToken": {}
}
}
},
"AdminListGroupsForUser": {
"input": {
"type": "structure",
"required": [
"Username",
"UserPoolId"
],
"members": {
"Username": {
"shape": "Sd"
},
"UserPoolId": {},
"Limit": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"Groups": {
"shape": "S28"
},
"NextToken": {}
}
}
},
"AdminListUserAuthEvents": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"AuthEvents": {
"type": "list",
"member": {
"type": "structure",
"members": {
"EventId": {},
"EventType": {},
"CreationDate": {
"type": "timestamp"
},
"EventResponse": {},
"EventRisk": {
"type": "structure",
"members": {
"RiskDecision": {},
"RiskLevel": {}
}
},
"ChallengeResponses": {
"type": "list",
"member": {
"type": "structure",
"members": {
"ChallengeName": {},
"ChallengeResponse": {}
}
}
},
"EventContextData": {
"type": "structure",
"members": {
"IpAddress": {},
"DeviceName": {},
"Timezone": {},
"City": {},
"Country": {}
}
},
"EventFeedback": {
"type": "structure",
"required": [
"FeedbackValue",
"Provider"
],
"members": {
"FeedbackValue": {},
"Provider": {},
"FeedbackDate": {
"type": "timestamp"
}
}
}
}
}
},
"NextToken": {}
}
}
},
"AdminRemoveUserFromGroup": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username",
"GroupName"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"GroupName": {}
}
}
},
"AdminResetUserPassword": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminRespondToAuthChallenge": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ClientId",
"ChallengeName"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
},
"ChallengeName": {},
"ChallengeResponses": {
"shape": "S2x"
},
"Session": {},
"AnalyticsMetadata": {
"shape": "S1m"
},
"ContextData": {
"shape": "S1n"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {
"ChallengeName": {},
"Session": {},
"ChallengeParameters": {
"shape": "S1t"
},
"AuthenticationResult": {
"shape": "S1u"
}
}
}
},
"AdminSetUserMFAPreference": {
"input": {
"type": "structure",
"required": [
"Username",
"UserPoolId"
],
"members": {
"SMSMfaSettings": {
"shape": "S30"
},
"SoftwareTokenMfaSettings": {
"shape": "S31"
},
"Username": {
"shape": "Sd"
},
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminSetUserPassword": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username",
"Password"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"Password": {
"shape": "Sn"
},
"Permanent": {
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminSetUserSettings": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username",
"MFAOptions"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"MFAOptions": {
"shape": "Sw"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminUpdateAuthEventFeedback": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username",
"EventId",
"FeedbackValue"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
},
"EventId": {},
"FeedbackValue": {}
}
},
"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": "Sj"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AdminUserGlobalSignOut": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Username"
],
"members": {
"UserPoolId": {},
"Username": {
"shape": "Sd"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateSoftwareToken": {
"input": {
"type": "structure",
"members": {
"AccessToken": {
"shape": "S1v"
},
"Session": {}
}
},
"output": {
"type": "structure",
"members": {
"SecretCode": {
"type": "string",
"sensitive": true
},
"Session": {}
}
}
},
"ChangePassword": {
"input": {
"type": "structure",
"required": [
"PreviousPassword",
"ProposedPassword",
"AccessToken"
],
"members": {
"PreviousPassword": {
"shape": "Sn"
},
"ProposedPassword": {
"shape": "Sn"
},
"AccessToken": {
"shape": "S1v"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"authtype": "none"
},
"ConfirmDevice": {
"input": {
"type": "structure",
"required": [
"AccessToken",
"DeviceKey"
],
"members": {
"AccessToken": {
"shape": "S1v"
},
"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": "S1j"
},
"SecretHash": {
"shape": "S3r"
},
"Username": {
"shape": "Sd"
},
"ConfirmationCode": {},
"Password": {
"shape": "Sn"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"UserContextData": {
"shape": "S3t"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"authtype": "none"
},
"ConfirmSignUp": {
"input": {
"type": "structure",
"required": [
"ClientId",
"Username",
"ConfirmationCode"
],
"members": {
"ClientId": {
"shape": "S1j"
},
"SecretHash": {
"shape": "S3r"
},
"Username": {
"shape": "Sd"
},
"ConfirmationCode": {},
"ForceAliasCreation": {
"type": "boolean"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"UserContextData": {
"shape": "S3t"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"authtype": "none"
},
"CreateGroup": {
"input": {
"type": "structure",
"required": [
"GroupName",
"UserPoolId"
],
"members": {
"GroupName": {},
"UserPoolId": {},
"Description": {},
"RoleArn": {},
"Precedence": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"Group": {
"shape": "S29"
}
}
}
},
"CreateIdentityProvider": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ProviderName",
"ProviderType",
"ProviderDetails"
],
"members": {
"UserPoolId": {},
"ProviderName": {},
"ProviderType": {},
"ProviderDetails": {
"shape": "S42"
},
"AttributeMapping": {
"shape": "S43"
},
"IdpIdentifiers": {
"shape": "S45"
}
}
},
"output": {
"type": "structure",
"required": [
"IdentityProvider"
],
"members": {
"IdentityProvider": {
"shape": "S48"
}
}
}
},
"CreateResourceServer": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Identifier",
"Name"
],
"members": {
"UserPoolId": {},
"Identifier": {},
"Name": {},
"Scopes": {
"shape": "S4c"
}
}
},
"output": {
"type": "structure",
"required": [
"ResourceServer"
],
"members": {
"ResourceServer": {
"shape": "S4h"
}
}
}
},
"CreateUserImportJob": {
"input": {
"type": "structure",
"required": [
"JobName",
"UserPoolId",
"CloudWatchLogsRoleArn"
],
"members": {
"JobName": {},
"UserPoolId": {},
"CloudWatchLogsRoleArn": {}
}
},
"output": {
"type": "structure",
"members": {
"UserImportJob": {
"shape": "S4l"
}
}
}
},
"CreateUserPool": {
"input": {
"type": "structure",
"required": [
"PoolName"
],
"members": {
"PoolName": {},
"Policies": {
"shape": "S4t"
},
"LambdaConfig": {
"shape": "S4x"
},
"AutoVerifiedAttributes": {
"shape": "S4y"
},
"AliasAttributes": {
"shape": "S50"
},
"UsernameAttributes": {
"shape": "S52"
},
"SmsVerificationMessage": {},
"EmailVerificationMessage": {},
"EmailVerificationSubject": {},
"VerificationMessageTemplate": {
"shape": "S57"
},
"SmsAuthenticationMessage": {},
"MfaConfiguration": {},
"DeviceConfiguration": {
"shape": "S5c"
},
"EmailConfiguration": {
"shape": "S5d"
},
"SmsConfiguration": {
"shape": "S5g"
},
"UserPoolTags": {
"shape": "S5h"
},
"AdminCreateUserConfig": {
"shape": "S5k"
},
"Schema": {
"shape": "S5n"
},
"UserPoolAddOns": {
"shape": "S5o"
}
}
},
"output": {
"type": "structure",
"members": {
"UserPool": {
"shape": "S5r"
}
}
}
},
"CreateUserPoolClient": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ClientName"
],
"members": {
"UserPoolId": {},
"ClientName": {},
"GenerateSecret": {
"type": "boolean"
},
"RefreshTokenValidity": {
"type": "integer"
},
"ReadAttributes": {
"shape": "S5y"
},
"WriteAttributes": {
"shape": "S5y"
},
"ExplicitAuthFlows": {
"shape": "S60"
},
"SupportedIdentityProviders": {
"shape": "S62"
},
"CallbackURLs": {
"shape": "S63"
},
"LogoutURLs": {
"shape": "S65"
},
"DefaultRedirectURI": {},
"AllowedOAuthFlows": {
"shape": "S66"
},
"AllowedOAuthScopes": {
"shape": "S68"
},
"AllowedOAuthFlowsUserPoolClient": {
"type": "boolean"
},
"AnalyticsConfiguration": {
"shape": "S6a"
}
}
},
"output": {
"type": "structure",
"members": {
"UserPoolClient": {
"shape": "S6d"
}
}
}
},
"CreateUserPoolDomain": {
"input": {
"type": "structure",
"required": [
"Domain",
"UserPoolId"
],
"members": {
"Domain": {},
"UserPoolId": {},
"CustomDomainConfig": {
"shape": "S6g"
}
}
},
"output": {
"type": "structure",
"members": {
"CloudFrontDomain": {}
}
}
},
"DeleteGroup": {
"input": {
"type": "structure",
"required": [
"GroupName",
"UserPoolId"
],
"members": {
"GroupName": {},
"UserPoolId": {}
}
}
},
"DeleteIdentityProvider": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ProviderName"
],
"members": {
"UserPoolId": {},
"ProviderName": {}
}
}
},
"DeleteResourceServer": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Identifier"
],
"members": {
"UserPoolId": {},
"Identifier": {}
}
}
},
"DeleteUser": {
"input": {
"type": "structure",
"required": [
"AccessToken"
],
"members": {
"AccessToken": {
"shape": "S1v"
}
}
},
"authtype": "none"
},
"DeleteUserAttributes": {
"input": {
"type": "structure",
"required": [
"UserAttributeNames",
"AccessToken"
],
"members": {
"UserAttributeNames": {
"shape": "S10"
},
"AccessToken": {
"shape": "S1v"
}
}
},
"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": "S1j"
}
}
}
},
"DeleteUserPoolDomain": {
"input": {
"type": "structure",
"required": [
"Domain",
"UserPoolId"
],
"members": {
"Domain": {},
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DescribeIdentityProvider": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ProviderName"
],
"members": {
"UserPoolId": {},
"ProviderName": {}
}
},
"output": {
"type": "structure",
"required": [
"IdentityProvider"
],
"members": {
"IdentityProvider": {
"shape": "S48"
}
}
}
},
"DescribeResourceServer": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"Identifier"
],
"members": {
"UserPoolId": {},
"Identifier": {}
}
},
"output": {
"type": "structure",
"required": [
"ResourceServer"
],
"members": {
"ResourceServer": {
"shape": "S4h"
}
}
}
},
"DescribeRiskConfiguration": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
}
}
},
"output": {
"type": "structure",
"required": [
"RiskConfiguration"
],
"members": {
"RiskConfiguration": {
"shape": "S6y"
}
}
}
},
"DescribeUserImportJob": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"JobId"
],
"members": {
"UserPoolId": {},
"JobId": {}
}
},
"output": {
"type": "structure",
"members": {
"UserImportJob": {
"shape": "S4l"
}
}
}
},
"DescribeUserPool": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {
"UserPool": {
"shape": "S5r"
}
}
}
},
"DescribeUserPoolClient": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"ClientId"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
}
}
},
"output": {
"type": "structure",
"members": {
"UserPoolClient": {
"shape": "S6d"
}
}
}
},
"DescribeUserPoolDomain": {
"input": {
"type": "structure",
"required": [
"Domain"
],
"members": {
"Domain": {}
}
},
"output": {
"type": "structure",
"members": {
"DomainDescription": {
"type": "structure",
"members": {
"UserPoolId": {},
"AWSAccountId": {},
"Domain": {},
"S3Bucket": {},
"CloudFrontDistribution": {},
"Version": {},
"Status": {},
"CustomDomainConfig": {
"shape": "S6g"
}
}
}
}
}
},
"ForgetDevice": {
"input": {
"type": "structure",
"required": [
"DeviceKey"
],
"members": {
"AccessToken": {
"shape": "S1v"
},
"DeviceKey": {}
}
}
},
"ForgotPassword": {
"input": {
"type": "structure",
"required": [
"ClientId",
"Username"
],
"members": {
"ClientId": {
"shape": "S1j"
},
"SecretHash": {
"shape": "S3r"
},
"UserContextData": {
"shape": "S3t"
},
"Username": {
"shape": "Sd"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {
"CodeDeliveryDetails": {
"shape": "S7w"
}
}
},
"authtype": "none"
},
"GetCSVHeader": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {
"UserPoolId": {},
"CSVHeader": {
"type": "list",
"member": {}
}
}
}
},
"GetDevice": {
"input": {
"type": "structure",
"required": [
"DeviceKey"
],
"members": {
"DeviceKey": {},
"AccessToken": {
"shape": "S1v"
}
}
},
"output": {
"type": "structure",
"required": [
"Device"
],
"members": {
"Device": {
"shape": "S1e"
}
}
}
},
"GetGroup": {
"input": {
"type": "structure",
"required": [
"GroupName",
"UserPoolId"
],
"members": {
"GroupName": {},
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {
"Group": {
"shape": "S29"
}
}
}
},
"GetIdentityProviderByIdentifier": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"IdpIdentifier"
],
"members": {
"UserPoolId": {},
"IdpIdentifier": {}
}
},
"output": {
"type": "structure",
"required": [
"IdentityProvider"
],
"members": {
"IdentityProvider": {
"shape": "S48"
}
}
}
},
"GetSigningCertificate": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {
"Certificate": {}
}
}
},
"GetUICustomization": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
}
}
},
"output": {
"type": "structure",
"required": [
"UICustomization"
],
"members": {
"UICustomization": {
"shape": "S8a"
}
}
}
},
"GetUser": {
"input": {
"type": "structure",
"required": [
"AccessToken"
],
"members": {
"AccessToken": {
"shape": "S1v"
}
}
},
"output": {
"type": "structure",
"required": [
"Username",
"UserAttributes"
],
"members": {
"Username": {
"shape": "Sd"
},
"UserAttributes": {
"shape": "Sj"
},
"MFAOptions": {
"shape": "Sw"
},
"PreferredMfaSetting": {},
"UserMFASettingList": {
"shape": "S1h"
}
}
},
"authtype": "none"
},
"GetUserAttributeVerificationCode": {
"input": {
"type": "structure",
"required": [
"AccessToken",
"AttributeName"
],
"members": {
"AccessToken": {
"shape": "S1v"
},
"AttributeName": {},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {
"CodeDeliveryDetails": {
"shape": "S7w"
}
}
},
"authtype": "none"
},
"GetUserPoolMfaConfig": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {}
}
},
"output": {
"type": "structure",
"members": {
"SmsMfaConfiguration": {
"shape": "S8k"
},
"SoftwareTokenMfaConfiguration": {
"shape": "S8l"
},
"MfaConfiguration": {}
}
}
},
"GlobalSignOut": {
"input": {
"type": "structure",
"required": [
"AccessToken"
],
"members": {
"AccessToken": {
"shape": "S1v"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"InitiateAuth": {
"input": {
"type": "structure",
"required": [
"AuthFlow",
"ClientId"
],
"members": {
"AuthFlow": {},
"AuthParameters": {
"shape": "S1l"
},
"ClientMetadata": {
"shape": "Sg"
},
"ClientId": {
"shape": "S1j"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"UserContextData": {
"shape": "S3t"
}
}
},
"output": {
"type": "structure",
"members": {
"ChallengeName": {},
"Session": {},
"ChallengeParameters": {
"shape": "S1t"
},
"AuthenticationResult": {
"shape": "S1u"
}
}
}
},
"ListDevices": {
"input": {
"type": "structure",
"required": [
"AccessToken"
],
"members": {
"AccessToken": {
"shape": "S1v"
},
"Limit": {
"type": "integer"
},
"PaginationToken": {}
}
},
"output": {
"type": "structure",
"members": {
"Devices": {
"shape": "S24"
},
"PaginationToken": {}
}
}
},
"ListGroups": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"Limit": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"Groups": {
"shape": "S28"
},
"NextToken": {}
}
}
},
"ListIdentityProviders": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"Providers"
],
"members": {
"Providers": {
"type": "list",
"member": {
"type": "structure",
"members": {
"ProviderName": {},
"ProviderType": {},
"LastModifiedDate": {
"type": "timestamp"
},
"CreationDate": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"ListResourceServers": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"MaxResults": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"required": [
"ResourceServers"
],
"members": {
"ResourceServers": {
"type": "list",
"member": {
"shape": "S4h"
}
},
"NextToken": {}
}
}
},
"ListTagsForResource": {
"input": {
"type": "structure",
"required": [
"ResourceArn"
],
"members": {
"ResourceArn": {}
}
},
"output": {
"type": "structure",
"members": {
"Tags": {
"shape": "S5h"
}
}
}
},
"ListUserImportJobs": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"MaxResults"
],
"members": {
"UserPoolId": {},
"MaxResults": {
"type": "integer"
},
"PaginationToken": {}
}
},
"output": {
"type": "structure",
"members": {
"UserImportJobs": {
"type": "list",
"member": {
"shape": "S4l"
}
},
"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": "S1j"
},
"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": "S4x"
},
"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": {
"shape": "S9n"
},
"PaginationToken": {}
}
}
},
"ListUsersInGroup": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"GroupName"
],
"members": {
"UserPoolId": {},
"GroupName": {},
"Limit": {
"type": "integer"
},
"NextToken": {}
}
},
"output": {
"type": "structure",
"members": {
"Users": {
"shape": "S9n"
},
"NextToken": {}
}
}
},
"ResendConfirmationCode": {
"input": {
"type": "structure",
"required": [
"ClientId",
"Username"
],
"members": {
"ClientId": {
"shape": "S1j"
},
"SecretHash": {
"shape": "S3r"
},
"UserContextData": {
"shape": "S3t"
},
"Username": {
"shape": "Sd"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {
"CodeDeliveryDetails": {
"shape": "S7w"
}
}
},
"authtype": "none"
},
"RespondToAuthChallenge": {
"input": {
"type": "structure",
"required": [
"ClientId",
"ChallengeName"
],
"members": {
"ClientId": {
"shape": "S1j"
},
"ChallengeName": {},
"Session": {},
"ChallengeResponses": {
"shape": "S2x"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"UserContextData": {
"shape": "S3t"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"members": {
"ChallengeName": {},
"Session": {},
"ChallengeParameters": {
"shape": "S1t"
},
"AuthenticationResult": {
"shape": "S1u"
}
}
}
},
"SetRiskConfiguration": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
},
"CompromisedCredentialsRiskConfiguration": {
"shape": "S6z"
},
"AccountTakeoverRiskConfiguration": {
"shape": "S74"
},
"RiskExceptionConfiguration": {
"shape": "S7d"
}
}
},
"output": {
"type": "structure",
"required": [
"RiskConfiguration"
],
"members": {
"RiskConfiguration": {
"shape": "S6y"
}
}
}
},
"SetUICustomization": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"ClientId": {
"shape": "S1j"
},
"CSS": {},
"ImageFile": {
"type": "blob"
}
}
},
"output": {
"type": "structure",
"required": [
"UICustomization"
],
"members": {
"UICustomization": {
"shape": "S8a"
}
}
}
},
"SetUserMFAPreference": {
"input": {
"type": "structure",
"required": [
"AccessToken"
],
"members": {
"SMSMfaSettings": {
"shape": "S30"
},
"SoftwareTokenMfaSettings": {
"shape": "S31"
},
"AccessToken": {
"shape": "S1v"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"SetUserPoolMfaConfig": {
"input": {
"type": "structure",
"required": [
"UserPoolId"
],
"members": {
"UserPoolId": {},
"SmsMfaConfiguration": {
"shape": "S8k"
},
"SoftwareTokenMfaConfiguration": {
"shape": "S8l"
},
"MfaConfiguration": {}
}
},
"output": {
"type": "structure",
"members": {
"SmsMfaConfiguration": {
"shape": "S8k"
},
"SoftwareTokenMfaConfiguration": {
"shape": "S8l"
},
"MfaConfiguration": {}
}
}
},
"SetUserSettings": {
"input": {
"type": "structure",
"required": [
"AccessToken",
"MFAOptions"
],
"members": {
"AccessToken": {
"shape": "S1v"
},
"MFAOptions": {
"shape": "Sw"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"authtype": "none"
},
"SignUp": {
"input": {
"type": "structure",
"required": [
"ClientId",
"Username",
"Password"
],
"members": {
"ClientId": {
"shape": "S1j"
},
"SecretHash": {
"shape": "S3r"
},
"Username": {
"shape": "Sd"
},
"Password": {
"shape": "Sn"
},
"UserAttributes": {
"shape": "Sj"
},
"ValidationData": {
"shape": "Sj"
},
"AnalyticsMetadata": {
"shape": "S1m"
},
"UserContextData": {
"shape": "S3t"
},
"ClientMetadata": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"required": [
"UserConfirmed",
"UserSub"
],
"members": {
"UserConfirmed": {
"type": "boolean"
},
"CodeDeliveryDetails": {
"shape": "S7w"
},
"UserSub": {}
}
},
"authtype": "none"
},
"StartUserImportJob": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"JobId"
],
"members": {
"UserPoolId": {},
"JobId": {}
}
},
"output": {
"type": "structure",
"members": {
"UserImportJob": {
"shape": "S4l"
}
}
}
},
"StopUserImportJob": {
"input": {
"type": "structure",
"required": [
"UserPoolId",
"JobId"
],
"members": {
"UserPoolId": {},
"JobId": {}
}
},
"output": {
"type": "structure",
"members": {
"UserImportJob": {
"shape": "S4l"