models.cognito-idp-2016-04-18-intermediate.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
{
"customizationConfig" : {
"additionalShapeConstructors" : null,
"authPolicyActions" : {
"actionPrefix" : null,
"fileNamePrefix" : null,
"skip" : true
},
"calculateCRC32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customClientConfigFactory" : null,
"customCodeTemplates" : null,
"customErrorCodeFieldName" : null,
"customExceptionUnmarshallerImpl" : null,
"customFileHeader" : null,
"customResponseMetadataClassName" : null,
"customServiceMetadata" : null,
"customServiceNameForRequest" : null,
"customSignerProvider" : null,
"operationModifiers" : null,
"operationsWithResponseStreamContentLengthValidation" : null,
"renameShapes" : null,
"requestMetrics" : null,
"requiredParamValidationEnabled" : false,
"sdkModeledExceptionBaseClassName" : null,
"sendEmptyAutoConstructedListAsEmptyList" : null,
"sendExplicitlyEmptyListsForQuery" : false,
"serviceClientHoldInputStream" : false,
"shapeModifiers" : null,
"shapeSubstitutions" : null,
"simpleMethods" : null,
"skipInterfaceAdditions" : false,
"skipSmokeTests" : false,
"useAutoConstructList" : false,
"useAutoConstructMap" : false
},
"metadata" : {
"apiVersion" : "2016-04-18",
"asyncClient" : "AWSCognitoIdentityProviderAsyncClient",
"asyncClientBuilderClassName" : "AWSCognitoIdentityProviderAsyncClientBuilder",
"asyncInterface" : "AWSCognitoIdentityProviderAsync",
"cborProtocol" : false,
"checksumFormat" : null,
"contentType" : null,
"cucumberModuleInjectorClassName" : "AWSCognitoIdentityProviderModuleInjector",
"defaultEndpoint" : "https://cognito-idp.us-east-1.amazonaws.com",
"defaultEndpointWithoutHttpProtocol" : "cognito-idp.us-east-1.amazonaws.com",
"documentation" : "Using the Amazon Cognito Your User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.
This API reference provides information about user pools in Amazon Cognito Your User Pools.
For more information, see the Amazon Cognito Documentation.
",
"endpointPrefix" : "cognito-idp",
"hasApiWithStreamInput" : false,
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"packageName" : "com.amazonaws.services.cognitoidp",
"packagePath" : "com/amazonaws/services/cognitoidp",
"protocol" : "json",
"protocolDefaultExceptionUmarshallerImpl" : null,
"serviceAbbreviation" : null,
"serviceFullName" : "Amazon Cognito Identity Provider",
"serviceName" : "Amazon Cognito Identity Provider",
"signingName" : "cognito-idp",
"smokeTestsPackageName" : "com.amazonaws.services.cognitoidp.smoketests",
"syncClient" : "AWSCognitoIdentityProviderClient",
"syncClientBuilderClassName" : "AWSCognitoIdentityProviderClientBuilder",
"syncInterface" : "AWSCognitoIdentityProvider",
"unmarshallerClassSuffix" : "JsonUnmarshaller",
"unmarshallerContextClassName" : "JsonUnmarshallerContext",
"xmlProtocol" : false
},
"operations" : {
"AddCustomAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AddCustomAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds additional user attributes to the user pool schema.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserImportInProgressException",
"documentation" : "This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AddCustomAttributesRequest",
"variableName" : "addCustomAttributesRequest",
"variableType" : "AddCustomAttributesRequest",
"documentation" : "Represents the request to add custom attributes.
",
"simpleType" : "AddCustomAttributesRequest",
"variableSetterType" : "AddCustomAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "addCustomAttributes",
"operationName" : "AddCustomAttributes",
"returnType" : {
"returnType" : "AddCustomAttributesResult",
"documentation" : "Represents the response from the server for the request to add custom attributes.
"
},
"syncReturnType" : "AddCustomAttributesResult"
},
"AdminConfirmSignUp" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminConfirmSignUpResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Confirms user registration as an admin without using a confirmation code. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyFailedAttemptsException",
"documentation" : "This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminConfirmSignUpRequest",
"variableName" : "adminConfirmSignUpRequest",
"variableType" : "AdminConfirmSignUpRequest",
"documentation" : "Represents the request to confirm user registration.
",
"simpleType" : "AdminConfirmSignUpRequest",
"variableSetterType" : "AdminConfirmSignUpRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminConfirmSignUp",
"operationName" : "AdminConfirmSignUp",
"returnType" : {
"returnType" : "AdminConfirmSignUpResult",
"documentation" : "Represents the response from the server for the request to confirm registration.
"
},
"syncReturnType" : "AdminConfirmSignUpResult"
},
"AdminCreateUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminCreateUserResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Requires developer credentials.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UsernameExistsException",
"documentation" : "This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "CodeDeliveryFailureException",
"documentation" : "This exception is thrown when a verification code fails to deliver successfully.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "PreconditionNotMetException",
"documentation" : "This exception is thrown when a precondition is not met.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UnsupportedUserStateException",
"documentation" : "The request failed because the user is in an unsupported state.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminCreateUserRequest",
"variableName" : "adminCreateUserRequest",
"variableType" : "AdminCreateUserRequest",
"documentation" : "Represents the request to create a user in the specified user pool.
",
"simpleType" : "AdminCreateUserRequest",
"variableSetterType" : "AdminCreateUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminCreateUser",
"operationName" : "AdminCreateUser",
"returnType" : {
"returnType" : "AdminCreateUserResult",
"documentation" : "Represents the response from the server to the request to create the user.
"
},
"syncReturnType" : "AdminCreateUserResult"
},
"AdminDeleteUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminDeleteUserResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a user as an administrator. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminDeleteUserRequest",
"variableName" : "adminDeleteUserRequest",
"variableType" : "AdminDeleteUserRequest",
"documentation" : "Represents the request to delete a user as an administrator.
",
"simpleType" : "AdminDeleteUserRequest",
"variableSetterType" : "AdminDeleteUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminDeleteUser",
"operationName" : "AdminDeleteUser",
"returnType" : {
"returnType" : "AdminDeleteUserResult",
"documentation" : null
},
"syncReturnType" : "AdminDeleteUserResult"
},
"AdminDeleteUserAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminDeleteUserAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the user attributes in a user pool as an administrator. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminDeleteUserAttributesRequest",
"variableName" : "adminDeleteUserAttributesRequest",
"variableType" : "AdminDeleteUserAttributesRequest",
"documentation" : "Represents the request to delete user attributes as an administrator.
",
"simpleType" : "AdminDeleteUserAttributesRequest",
"variableSetterType" : "AdminDeleteUserAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminDeleteUserAttributes",
"operationName" : "AdminDeleteUserAttributes",
"returnType" : {
"returnType" : "AdminDeleteUserAttributesResult",
"documentation" : "Represents the response received from the server for a request to delete user attributes.
"
},
"syncReturnType" : "AdminDeleteUserAttributesResult"
},
"AdminDisableUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminDisableUserResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Disables the specified user as an administrator. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminDisableUserRequest",
"variableName" : "adminDisableUserRequest",
"variableType" : "AdminDisableUserRequest",
"documentation" : "Represents the request to disable any user as an administrator.
",
"simpleType" : "AdminDisableUserRequest",
"variableSetterType" : "AdminDisableUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminDisableUser",
"operationName" : "AdminDisableUser",
"returnType" : {
"returnType" : "AdminDisableUserResult",
"documentation" : "Represents the response received from the server to disable the user as an administrator.
"
},
"syncReturnType" : "AdminDisableUserResult"
},
"AdminEnableUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminEnableUserResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Enables the specified user as an administrator. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminEnableUserRequest",
"variableName" : "adminEnableUserRequest",
"variableType" : "AdminEnableUserRequest",
"documentation" : "Represents the request that enables the user as an administrator.
",
"simpleType" : "AdminEnableUserRequest",
"variableSetterType" : "AdminEnableUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminEnableUser",
"operationName" : "AdminEnableUser",
"returnType" : {
"returnType" : "AdminEnableUserResult",
"documentation" : "Represents the response from the server for the request to enable a user as an administrator.
"
},
"syncReturnType" : "AdminEnableUserResult"
},
"AdminForgetDevice" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminForgetDeviceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Forgets the device, as an administrator.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminForgetDeviceRequest",
"variableName" : "adminForgetDeviceRequest",
"variableType" : "AdminForgetDeviceRequest",
"documentation" : "Sends the forgot device request, as an administrator.
",
"simpleType" : "AdminForgetDeviceRequest",
"variableSetterType" : "AdminForgetDeviceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminForgetDevice",
"operationName" : "AdminForgetDevice",
"returnType" : {
"returnType" : "AdminForgetDeviceResult",
"documentation" : null
},
"syncReturnType" : "AdminForgetDeviceResult"
},
"AdminGetDevice" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminGetDeviceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the device, as an administrator.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminGetDeviceRequest",
"variableName" : "adminGetDeviceRequest",
"variableType" : "AdminGetDeviceRequest",
"documentation" : "Represents the request to get the device, as an administrator.
",
"simpleType" : "AdminGetDeviceRequest",
"variableSetterType" : "AdminGetDeviceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminGetDevice",
"operationName" : "AdminGetDevice",
"returnType" : {
"returnType" : "AdminGetDeviceResult",
"documentation" : "Gets the device response, as an administrator.
"
},
"syncReturnType" : "AdminGetDeviceResult"
},
"AdminGetUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminGetUserResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the specified user by user name in a user pool as an administrator. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminGetUserRequest",
"variableName" : "adminGetUserRequest",
"variableType" : "AdminGetUserRequest",
"documentation" : "Represents the request to get the specified user as an administrator.
",
"simpleType" : "AdminGetUserRequest",
"variableSetterType" : "AdminGetUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminGetUser",
"operationName" : "AdminGetUser",
"returnType" : {
"returnType" : "AdminGetUserResult",
"documentation" : "Represents the response from the server from the request to get the specified user as an administrator.
"
},
"syncReturnType" : "AdminGetUserResult"
},
"AdminInitiateAuth" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminInitiateAuthResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Initiates the authentication flow, as an administrator.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "MFAMethodNotFoundException",
"documentation" : "This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminInitiateAuthRequest",
"variableName" : "adminInitiateAuthRequest",
"variableType" : "AdminInitiateAuthRequest",
"documentation" : "Initiates the authorization request, as an administrator.
",
"simpleType" : "AdminInitiateAuthRequest",
"variableSetterType" : "AdminInitiateAuthRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminInitiateAuth",
"operationName" : "AdminInitiateAuth",
"returnType" : {
"returnType" : "AdminInitiateAuthResult",
"documentation" : "Initiates the authentication response, as an administrator.
"
},
"syncReturnType" : "AdminInitiateAuthResult"
},
"AdminListDevices" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminListDevicesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists devices, as an administrator.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminListDevicesRequest",
"variableName" : "adminListDevicesRequest",
"variableType" : "AdminListDevicesRequest",
"documentation" : "Represents the request to list devices, as an administrator.
",
"simpleType" : "AdminListDevicesRequest",
"variableSetterType" : "AdminListDevicesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminListDevices",
"operationName" : "AdminListDevices",
"returnType" : {
"returnType" : "AdminListDevicesResult",
"documentation" : "Lists the device's response, as an administrator.
"
},
"syncReturnType" : "AdminListDevicesResult"
},
"AdminResetUserPassword" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminResetUserPasswordResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminResetUserPasswordRequest",
"variableName" : "adminResetUserPasswordRequest",
"variableType" : "AdminResetUserPasswordRequest",
"documentation" : "Represents the request to reset a user's password as an administrator.
",
"simpleType" : "AdminResetUserPasswordRequest",
"variableSetterType" : "AdminResetUserPasswordRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminResetUserPassword",
"operationName" : "AdminResetUserPassword",
"returnType" : {
"returnType" : "AdminResetUserPasswordResult",
"documentation" : "Represents the response from the server to reset a user password as an administrator.
"
},
"syncReturnType" : "AdminResetUserPasswordResult"
},
"AdminRespondToAuthChallenge" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminRespondToAuthChallengeResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Responds to an authentication challenge, as an administrator.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "CodeMismatchException",
"documentation" : "This exception is thrown if the provided code does not match what the server was expecting.
"
}, {
"exceptionName" : "ExpiredCodeException",
"documentation" : "This exception is thrown if a code has expired.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "MFAMethodNotFoundException",
"documentation" : "This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "AliasExistsException",
"documentation" : "This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminRespondToAuthChallengeRequest",
"variableName" : "adminRespondToAuthChallengeRequest",
"variableType" : "AdminRespondToAuthChallengeRequest",
"documentation" : "The request to respond to the authentication challenge, as an administrator.
",
"simpleType" : "AdminRespondToAuthChallengeRequest",
"variableSetterType" : "AdminRespondToAuthChallengeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminRespondToAuthChallenge",
"operationName" : "AdminRespondToAuthChallenge",
"returnType" : {
"returnType" : "AdminRespondToAuthChallengeResult",
"documentation" : "Responds to the authentication challenge, as an administrator.
"
},
"syncReturnType" : "AdminRespondToAuthChallengeResult"
},
"AdminSetUserSettings" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminSetUserSettingsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Sets all the user settings for a specified user name. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminSetUserSettingsRequest",
"variableName" : "adminSetUserSettingsRequest",
"variableType" : "AdminSetUserSettingsRequest",
"documentation" : "Represents the request to set user settings as an administrator.
",
"simpleType" : "AdminSetUserSettingsRequest",
"variableSetterType" : "AdminSetUserSettingsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminSetUserSettings",
"operationName" : "AdminSetUserSettings",
"returnType" : {
"returnType" : "AdminSetUserSettingsResult",
"documentation" : "Represents the response from the server to set user settings as an administrator.
"
},
"syncReturnType" : "AdminSetUserSettingsResult"
},
"AdminUpdateDeviceStatus" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminUpdateDeviceStatusResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the device status as an administrator.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminUpdateDeviceStatusRequest",
"variableName" : "adminUpdateDeviceStatusRequest",
"variableType" : "AdminUpdateDeviceStatusRequest",
"documentation" : "The request to update the device status, as an administrator.
",
"simpleType" : "AdminUpdateDeviceStatusRequest",
"variableSetterType" : "AdminUpdateDeviceStatusRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminUpdateDeviceStatus",
"operationName" : "AdminUpdateDeviceStatus",
"returnType" : {
"returnType" : "AdminUpdateDeviceStatusResult",
"documentation" : "The status response from the request to update the device, as an administrator.
"
},
"syncReturnType" : "AdminUpdateDeviceStatusResult"
},
"AdminUpdateUserAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminUpdateUserAttributesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "AliasExistsException",
"documentation" : "This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminUpdateUserAttributesRequest",
"variableName" : "adminUpdateUserAttributesRequest",
"variableType" : "AdminUpdateUserAttributesRequest",
"documentation" : "Represents the request to update the user's attributes as an administrator.
",
"simpleType" : "AdminUpdateUserAttributesRequest",
"variableSetterType" : "AdminUpdateUserAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminUpdateUserAttributes",
"operationName" : "AdminUpdateUserAttributes",
"returnType" : {
"returnType" : "AdminUpdateUserAttributesResult",
"documentation" : "Represents the response from the server for the request to update user attributes as an administrator.
"
},
"syncReturnType" : "AdminUpdateUserAttributesResult"
},
"AdminUserGlobalSignOut" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "AdminUserGlobalSignOutResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Signs out users from all devices, as an administrator.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "AdminUserGlobalSignOutRequest",
"variableName" : "adminUserGlobalSignOutRequest",
"variableType" : "AdminUserGlobalSignOutRequest",
"documentation" : "The request to sign out of all devices, as an administrator.
",
"simpleType" : "AdminUserGlobalSignOutRequest",
"variableSetterType" : "AdminUserGlobalSignOutRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "adminUserGlobalSignOut",
"operationName" : "AdminUserGlobalSignOut",
"returnType" : {
"returnType" : "AdminUserGlobalSignOutResult",
"documentation" : "The global sign-out response, as an administrator.
"
},
"syncReturnType" : "AdminUserGlobalSignOutResult"
},
"ChangePassword" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ChangePasswordResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Changes the password for a specified user in a user pool.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ChangePasswordRequest",
"variableName" : "changePasswordRequest",
"variableType" : "ChangePasswordRequest",
"documentation" : "Represents the request to change a user password.
",
"simpleType" : "ChangePasswordRequest",
"variableSetterType" : "ChangePasswordRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "changePassword",
"operationName" : "ChangePassword",
"returnType" : {
"returnType" : "ChangePasswordResult",
"documentation" : "The response from the server to the change password request.
"
},
"syncReturnType" : "ChangePasswordResult"
},
"ConfirmDevice" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ConfirmDeviceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Confirms tracking of the device. This API call is the call that beings device tracking.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "UsernameExistsException",
"documentation" : "This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ConfirmDeviceRequest",
"variableName" : "confirmDeviceRequest",
"variableType" : "ConfirmDeviceRequest",
"documentation" : "Confirms the device request.
",
"simpleType" : "ConfirmDeviceRequest",
"variableSetterType" : "ConfirmDeviceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "confirmDevice",
"operationName" : "ConfirmDevice",
"returnType" : {
"returnType" : "ConfirmDeviceResult",
"documentation" : "Confirms the device response.
"
},
"syncReturnType" : "ConfirmDeviceResult"
},
"ConfirmForgotPassword" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ConfirmForgotPasswordResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Allows a user to enter a code provided when they reset their password to update their password.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "CodeMismatchException",
"documentation" : "This exception is thrown if the provided code does not match what the server was expecting.
"
}, {
"exceptionName" : "ExpiredCodeException",
"documentation" : "This exception is thrown if a code has expired.
"
}, {
"exceptionName" : "TooManyFailedAttemptsException",
"documentation" : "This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ConfirmForgotPasswordRequest",
"variableName" : "confirmForgotPasswordRequest",
"variableType" : "ConfirmForgotPasswordRequest",
"documentation" : "The request representing the confirmation for a password reset.
",
"simpleType" : "ConfirmForgotPasswordRequest",
"variableSetterType" : "ConfirmForgotPasswordRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "confirmForgotPassword",
"operationName" : "ConfirmForgotPassword",
"returnType" : {
"returnType" : "ConfirmForgotPasswordResult",
"documentation" : "The response from the server that results from a user's request to retrieve a forgotten password.
"
},
"syncReturnType" : "ConfirmForgotPasswordResult"
},
"ConfirmSignUp" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ConfirmSignUpResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Confirms registration of a user and handles the existing alias from a previous user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyFailedAttemptsException",
"documentation" : "This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).
"
}, {
"exceptionName" : "CodeMismatchException",
"documentation" : "This exception is thrown if the provided code does not match what the server was expecting.
"
}, {
"exceptionName" : "ExpiredCodeException",
"documentation" : "This exception is thrown if a code has expired.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "AliasExistsException",
"documentation" : "This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ConfirmSignUpRequest",
"variableName" : "confirmSignUpRequest",
"variableType" : "ConfirmSignUpRequest",
"documentation" : "Represents the request to confirm registration of a user.
",
"simpleType" : "ConfirmSignUpRequest",
"variableSetterType" : "ConfirmSignUpRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "confirmSignUp",
"operationName" : "ConfirmSignUp",
"returnType" : {
"returnType" : "ConfirmSignUpResult",
"documentation" : "Represents the response from the server for the registration confirmation.
"
},
"syncReturnType" : "ConfirmSignUpResult"
},
"CreateUserImportJob" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateUserImportJobResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates the user import job.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PreconditionNotMetException",
"documentation" : "This exception is thrown when a precondition is not met.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateUserImportJobRequest",
"variableName" : "createUserImportJobRequest",
"variableType" : "CreateUserImportJobRequest",
"documentation" : "Represents the request to create the user import job.
",
"simpleType" : "CreateUserImportJobRequest",
"variableSetterType" : "CreateUserImportJobRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createUserImportJob",
"operationName" : "CreateUserImportJob",
"returnType" : {
"returnType" : "CreateUserImportJobResult",
"documentation" : "Represents the response from the server to the request to create the user import job.
"
},
"syncReturnType" : "CreateUserImportJobResult"
},
"CreateUserPool" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateUserPoolResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a new Amazon Cognito user pool and sets the password policy for the pool.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateUserPoolRequest",
"variableName" : "createUserPoolRequest",
"variableType" : "CreateUserPoolRequest",
"documentation" : "Represents the request to create a user pool.
",
"simpleType" : "CreateUserPoolRequest",
"variableSetterType" : "CreateUserPoolRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createUserPool",
"operationName" : "CreateUserPool",
"returnType" : {
"returnType" : "CreateUserPoolResult",
"documentation" : "Represents the response from the server for the request to create a user pool.
"
},
"syncReturnType" : "CreateUserPoolResult"
},
"CreateUserPoolClient" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "CreateUserPoolClientResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates the user pool client.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateUserPoolClientRequest",
"variableName" : "createUserPoolClientRequest",
"variableType" : "CreateUserPoolClientRequest",
"documentation" : "Represents the request to create a user pool client.
",
"simpleType" : "CreateUserPoolClientRequest",
"variableSetterType" : "CreateUserPoolClientRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "createUserPoolClient",
"operationName" : "CreateUserPoolClient",
"returnType" : {
"returnType" : "CreateUserPoolClientResult",
"documentation" : "Represents the response from the server to create a user pool client.
"
},
"syncReturnType" : "CreateUserPoolClientResult"
},
"DeleteUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteUserResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Allows a user to delete one's self.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUserRequest",
"variableName" : "deleteUserRequest",
"variableType" : "DeleteUserRequest",
"documentation" : "Represents the request to delete a user.
",
"simpleType" : "DeleteUserRequest",
"variableSetterType" : "DeleteUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteUser",
"operationName" : "DeleteUser",
"returnType" : {
"returnType" : "DeleteUserResult",
"documentation" : null
},
"syncReturnType" : "DeleteUserResult"
},
"DeleteUserAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteUserAttributesResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Deletes the attributes for a user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUserAttributesRequest",
"variableName" : "deleteUserAttributesRequest",
"variableType" : "DeleteUserAttributesRequest",
"documentation" : "Represents the request to delete user attributes.
",
"simpleType" : "DeleteUserAttributesRequest",
"variableSetterType" : "DeleteUserAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteUserAttributes",
"operationName" : "DeleteUserAttributes",
"returnType" : {
"returnType" : "DeleteUserAttributesResult",
"documentation" : "Represents the response from the server to delete user attributes.
"
},
"syncReturnType" : "DeleteUserAttributesResult"
},
"DeleteUserPool" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteUserPoolResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the specified Amazon Cognito user pool.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserImportInProgressException",
"documentation" : "This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUserPoolRequest",
"variableName" : "deleteUserPoolRequest",
"variableType" : "DeleteUserPoolRequest",
"documentation" : "Represents the request to delete a user pool.
",
"simpleType" : "DeleteUserPoolRequest",
"variableSetterType" : "DeleteUserPoolRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteUserPool",
"operationName" : "DeleteUserPool",
"returnType" : {
"returnType" : "DeleteUserPoolResult",
"documentation" : null
},
"syncReturnType" : "DeleteUserPoolResult"
},
"DeleteUserPoolClient" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DeleteUserPoolClientResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Allows the developer to delete the user pool client.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUserPoolClientRequest",
"variableName" : "deleteUserPoolClientRequest",
"variableType" : "DeleteUserPoolClientRequest",
"documentation" : "Represents the request to delete a user pool client.
",
"simpleType" : "DeleteUserPoolClientRequest",
"variableSetterType" : "DeleteUserPoolClientRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "deleteUserPoolClient",
"operationName" : "DeleteUserPoolClient",
"returnType" : {
"returnType" : "DeleteUserPoolClientResult",
"documentation" : null
},
"syncReturnType" : "DeleteUserPoolClientResult"
},
"DescribeUserImportJob" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeUserImportJobResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes the user import job.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeUserImportJobRequest",
"variableName" : "describeUserImportJobRequest",
"variableType" : "DescribeUserImportJobRequest",
"documentation" : "Represents the request to describe the user import job.
",
"simpleType" : "DescribeUserImportJobRequest",
"variableSetterType" : "DescribeUserImportJobRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeUserImportJob",
"operationName" : "DescribeUserImportJob",
"returnType" : {
"returnType" : "DescribeUserImportJobResult",
"documentation" : "Represents the response from the server to the request to describe the user import job.
"
},
"syncReturnType" : "DescribeUserImportJobResult"
},
"DescribeUserPool" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeUserPoolResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Returns the configuration information and metadata of the specified user pool.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeUserPoolRequest",
"variableName" : "describeUserPoolRequest",
"variableType" : "DescribeUserPoolRequest",
"documentation" : "Represents the request to describe the user pool.
",
"simpleType" : "DescribeUserPoolRequest",
"variableSetterType" : "DescribeUserPoolRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeUserPool",
"operationName" : "DescribeUserPool",
"returnType" : {
"returnType" : "DescribeUserPoolResult",
"documentation" : "Represents the response to describe the user pool.
"
},
"syncReturnType" : "DescribeUserPoolResult"
},
"DescribeUserPoolClient" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "DescribeUserPoolClientResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Client method for returning the configuration information and metadata of the specified user pool client.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeUserPoolClientRequest",
"variableName" : "describeUserPoolClientRequest",
"variableType" : "DescribeUserPoolClientRequest",
"documentation" : "Represents the request to describe a user pool client.
",
"simpleType" : "DescribeUserPoolClientRequest",
"variableSetterType" : "DescribeUserPoolClientRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "describeUserPoolClient",
"operationName" : "DescribeUserPoolClient",
"returnType" : {
"returnType" : "DescribeUserPoolClientResult",
"documentation" : "Represents the response from the server from a request to describe the user pool client.
"
},
"syncReturnType" : "DescribeUserPoolClientResult"
},
"ForgetDevice" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ForgetDeviceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Forgets the specified device.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ForgetDeviceRequest",
"variableName" : "forgetDeviceRequest",
"variableType" : "ForgetDeviceRequest",
"documentation" : "Represents the request to forget the device.
",
"simpleType" : "ForgetDeviceRequest",
"variableSetterType" : "ForgetDeviceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "forgetDevice",
"operationName" : "ForgetDevice",
"returnType" : {
"returnType" : "ForgetDeviceResult",
"documentation" : null
},
"syncReturnType" : "ForgetDeviceResult"
},
"ForgotPassword" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ForgotPasswordResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Retrieves the password for the specified client ID or username.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
}, {
"exceptionName" : "CodeDeliveryFailureException",
"documentation" : "This exception is thrown when a verification code fails to deliver successfully.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ForgotPasswordRequest",
"variableName" : "forgotPasswordRequest",
"variableType" : "ForgotPasswordRequest",
"documentation" : "Represents the request to reset a user's password.
",
"simpleType" : "ForgotPasswordRequest",
"variableSetterType" : "ForgotPasswordRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "forgotPassword",
"operationName" : "ForgotPassword",
"returnType" : {
"returnType" : "ForgotPasswordResult",
"documentation" : "Respresents the response from the server regarding the request to reset a password.
"
},
"syncReturnType" : "ForgotPasswordResult"
},
"GetCSVHeader" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetCSVHeaderResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the header information for the .csv file to be used as input for the user import job.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetCSVHeaderRequest",
"variableName" : "getCSVHeaderRequest",
"variableType" : "GetCSVHeaderRequest",
"documentation" : "Represents the request to get the header information for the .csv file for the user import job.
",
"simpleType" : "GetCSVHeaderRequest",
"variableSetterType" : "GetCSVHeaderRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getCSVHeader",
"operationName" : "GetCSVHeader",
"returnType" : {
"returnType" : "GetCSVHeaderResult",
"documentation" : "Represents the response from the server to the request to get the header information for the .csv file for the user import job.
"
},
"syncReturnType" : "GetCSVHeaderResult"
},
"GetDevice" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetDeviceResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Gets the device.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetDeviceRequest",
"variableName" : "getDeviceRequest",
"variableType" : "GetDeviceRequest",
"documentation" : "Represents the request to get the device.
",
"simpleType" : "GetDeviceRequest",
"variableSetterType" : "GetDeviceRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getDevice",
"operationName" : "GetDevice",
"returnType" : {
"returnType" : "GetDeviceResult",
"documentation" : "Gets the device response.
"
},
"syncReturnType" : "GetDeviceResult"
},
"GetUser" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUserResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Gets the user attributes and metadata for a user.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUserRequest",
"variableName" : "getUserRequest",
"variableType" : "GetUserRequest",
"documentation" : "Represents the request to get information about the user.
",
"simpleType" : "GetUserRequest",
"variableSetterType" : "GetUserRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUser",
"operationName" : "GetUser",
"returnType" : {
"returnType" : "GetUserResult",
"documentation" : "Represents the response from the server from the request to get information about the user.
"
},
"syncReturnType" : "GetUserResult"
},
"GetUserAttributeVerificationCode" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GetUserAttributeVerificationCodeResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Gets the user attribute verification code for the specified attribute name.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
}, {
"exceptionName" : "CodeDeliveryFailureException",
"documentation" : "This exception is thrown when a verification code fails to deliver successfully.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GetUserAttributeVerificationCodeRequest",
"variableName" : "getUserAttributeVerificationCodeRequest",
"variableType" : "GetUserAttributeVerificationCodeRequest",
"documentation" : "Represents the request to get user attribute verification.
",
"simpleType" : "GetUserAttributeVerificationCodeRequest",
"variableSetterType" : "GetUserAttributeVerificationCodeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "getUserAttributeVerificationCode",
"operationName" : "GetUserAttributeVerificationCode",
"returnType" : {
"returnType" : "GetUserAttributeVerificationCodeResult",
"documentation" : "The verification code response returned by the server response to get the user attribute verification code.
"
},
"syncReturnType" : "GetUserAttributeVerificationCodeResult"
},
"GlobalSignOut" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "GlobalSignOutResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Signs out users from all devices.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "GlobalSignOutRequest",
"variableName" : "globalSignOutRequest",
"variableType" : "GlobalSignOutRequest",
"documentation" : "Represents the request to sign out all devices.
",
"simpleType" : "GlobalSignOutRequest",
"variableSetterType" : "GlobalSignOutRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "globalSignOut",
"operationName" : "GlobalSignOut",
"returnType" : {
"returnType" : "GlobalSignOutResult",
"documentation" : "The response to the request to sign out all devices.
"
},
"syncReturnType" : "GlobalSignOutResult"
},
"InitiateAuth" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "InitiateAuthResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Initiates the authentication flow.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "InitiateAuthRequest",
"variableName" : "initiateAuthRequest",
"variableType" : "InitiateAuthRequest",
"documentation" : "Initiates the authentication request.
",
"simpleType" : "InitiateAuthRequest",
"variableSetterType" : "InitiateAuthRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "initiateAuth",
"operationName" : "InitiateAuth",
"returnType" : {
"returnType" : "InitiateAuthResult",
"documentation" : "Initiates the authentication response.
"
},
"syncReturnType" : "InitiateAuthResult"
},
"ListDevices" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListDevicesResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the devices.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListDevicesRequest",
"variableName" : "listDevicesRequest",
"variableType" : "ListDevicesRequest",
"documentation" : "Represents the request to list the devices.
",
"simpleType" : "ListDevicesRequest",
"variableSetterType" : "ListDevicesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listDevices",
"operationName" : "ListDevices",
"returnType" : {
"returnType" : "ListDevicesResult",
"documentation" : "Represents the response to list devices.
"
},
"syncReturnType" : "ListDevicesResult"
},
"ListUserImportJobs" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListUserImportJobsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the user import jobs.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListUserImportJobsRequest",
"variableName" : "listUserImportJobsRequest",
"variableType" : "ListUserImportJobsRequest",
"documentation" : "Represents the request to list the user import jobs.
",
"simpleType" : "ListUserImportJobsRequest",
"variableSetterType" : "ListUserImportJobsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listUserImportJobs",
"operationName" : "ListUserImportJobs",
"returnType" : {
"returnType" : "ListUserImportJobsResult",
"documentation" : "Represents the response from the server to the request to list the user import jobs.
"
},
"syncReturnType" : "ListUserImportJobsResult"
},
"ListUserPoolClients" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListUserPoolClientsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the clients that have been created for the specified user pool.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListUserPoolClientsRequest",
"variableName" : "listUserPoolClientsRequest",
"variableType" : "ListUserPoolClientsRequest",
"documentation" : "Represents the request to list the user pool clients.
",
"simpleType" : "ListUserPoolClientsRequest",
"variableSetterType" : "ListUserPoolClientsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listUserPoolClients",
"operationName" : "ListUserPoolClients",
"returnType" : {
"returnType" : "ListUserPoolClientsResult",
"documentation" : "Represents the response from the server that lists user pool clients.
"
},
"syncReturnType" : "ListUserPoolClientsResult"
},
"ListUserPools" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListUserPoolsResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the user pools associated with an AWS account.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListUserPoolsRequest",
"variableName" : "listUserPoolsRequest",
"variableType" : "ListUserPoolsRequest",
"documentation" : "Represents the request to list user pools.
",
"simpleType" : "ListUserPoolsRequest",
"variableSetterType" : "ListUserPoolsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listUserPools",
"operationName" : "ListUserPools",
"returnType" : {
"returnType" : "ListUserPoolsResult",
"documentation" : "Represents the response to list user pools.
"
},
"syncReturnType" : "ListUserPoolsResult"
},
"ListUsers" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ListUsersResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the users in the Amazon Cognito user pool.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListUsersRequest",
"variableName" : "listUsersRequest",
"variableType" : "ListUsersRequest",
"documentation" : "Represents the request to list users.
",
"simpleType" : "ListUsersRequest",
"variableSetterType" : "ListUsersRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "listUsers",
"operationName" : "ListUsers",
"returnType" : {
"returnType" : "ListUsersResult",
"documentation" : "The response from the request to list users.
"
},
"syncReturnType" : "ListUsersResult"
},
"ResendConfirmationCode" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "ResendConfirmationCodeResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
}, {
"exceptionName" : "CodeDeliveryFailureException",
"documentation" : "This exception is thrown when a verification code fails to deliver successfully.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ResendConfirmationCodeRequest",
"variableName" : "resendConfirmationCodeRequest",
"variableType" : "ResendConfirmationCodeRequest",
"documentation" : "Represents the request to resend the confirmation code.
",
"simpleType" : "ResendConfirmationCodeRequest",
"variableSetterType" : "ResendConfirmationCodeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "resendConfirmationCode",
"operationName" : "ResendConfirmationCode",
"returnType" : {
"returnType" : "ResendConfirmationCodeResult",
"documentation" : "The response from the server when the Amazon Cognito service makes the request to resend a confirmation code.
"
},
"syncReturnType" : "ResendConfirmationCodeResult"
},
"RespondToAuthChallenge" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "RespondToAuthChallengeResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Responds to the authentication challenge.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "CodeMismatchException",
"documentation" : "This exception is thrown if the provided code does not match what the server was expecting.
"
}, {
"exceptionName" : "ExpiredCodeException",
"documentation" : "This exception is thrown if a code has expired.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "MFAMethodNotFoundException",
"documentation" : "This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "AliasExistsException",
"documentation" : "This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "RespondToAuthChallengeRequest",
"variableName" : "respondToAuthChallengeRequest",
"variableType" : "RespondToAuthChallengeRequest",
"documentation" : "The request to respond to an authentication challenge.
",
"simpleType" : "RespondToAuthChallengeRequest",
"variableSetterType" : "RespondToAuthChallengeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "respondToAuthChallenge",
"operationName" : "RespondToAuthChallenge",
"returnType" : {
"returnType" : "RespondToAuthChallengeResult",
"documentation" : "The response to respond to the authentication challenge.
"
},
"syncReturnType" : "RespondToAuthChallengeResult"
},
"SetUserSettings" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "SetUserSettingsResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "SetUserSettingsRequest",
"variableName" : "setUserSettingsRequest",
"variableType" : "SetUserSettingsRequest",
"documentation" : "Represents the request to set user settings.
",
"simpleType" : "SetUserSettingsRequest",
"variableSetterType" : "SetUserSettingsRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "setUserSettings",
"operationName" : "SetUserSettings",
"returnType" : {
"returnType" : "SetUserSettingsResult",
"documentation" : "The response from the server for a set user settings request.
"
},
"syncReturnType" : "SetUserSettingsResult"
},
"SignUp" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "SignUpResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Registers the user in the specified user pool and creates a user name, password, and user attributes.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidPasswordException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid password.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "UsernameExistsException",
"documentation" : "This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
}, {
"exceptionName" : "CodeDeliveryFailureException",
"documentation" : "This exception is thrown when a verification code fails to deliver successfully.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "SignUpRequest",
"variableName" : "signUpRequest",
"variableType" : "SignUpRequest",
"documentation" : "Represents the request to register a user.
",
"simpleType" : "SignUpRequest",
"variableSetterType" : "SignUpRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "signUp",
"operationName" : "SignUp",
"returnType" : {
"returnType" : "SignUpResult",
"documentation" : "The response from the server for a registration request.
"
},
"syncReturnType" : "SignUpResult"
},
"StartUserImportJob" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "StartUserImportJobResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Starts the user import.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "PreconditionNotMetException",
"documentation" : "This exception is thrown when a precondition is not met.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "StartUserImportJobRequest",
"variableName" : "startUserImportJobRequest",
"variableType" : "StartUserImportJobRequest",
"documentation" : "Represents the request to start the user import job.
",
"simpleType" : "StartUserImportJobRequest",
"variableSetterType" : "StartUserImportJobRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "startUserImportJob",
"operationName" : "StartUserImportJob",
"returnType" : {
"returnType" : "StartUserImportJobResult",
"documentation" : "Represents the response from the server to the request to start the user import job.
"
},
"syncReturnType" : "StartUserImportJobResult"
},
"StopUserImportJob" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "StopUserImportJobResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Stops the user import job.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "PreconditionNotMetException",
"documentation" : "This exception is thrown when a precondition is not met.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "StopUserImportJobRequest",
"variableName" : "stopUserImportJobRequest",
"variableType" : "StopUserImportJobRequest",
"documentation" : "Represents the request to stop the user import job.
",
"simpleType" : "StopUserImportJobRequest",
"variableSetterType" : "StopUserImportJobRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "stopUserImportJob",
"operationName" : "StopUserImportJob",
"returnType" : {
"returnType" : "StopUserImportJobResult",
"documentation" : "Represents the response from the server to the request to stop the user import job.
"
},
"syncReturnType" : "StopUserImportJobResult"
},
"UpdateDeviceStatus" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateDeviceStatusResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the device status.
",
"exceptions" : [ {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InvalidUserPoolConfigurationException",
"documentation" : "This exception is thrown when the user pool configuration is invalid.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateDeviceStatusRequest",
"variableName" : "updateDeviceStatusRequest",
"variableType" : "UpdateDeviceStatusRequest",
"documentation" : "Represents the request to update the device status.
",
"simpleType" : "UpdateDeviceStatusRequest",
"variableSetterType" : "UpdateDeviceStatusRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateDeviceStatus",
"operationName" : "UpdateDeviceStatus",
"returnType" : {
"returnType" : "UpdateDeviceStatusResult",
"documentation" : "The response to the request to update the device status.
"
},
"syncReturnType" : "UpdateDeviceStatusResult"
},
"UpdateUserAttributes" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateUserAttributesResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Allows a user to update a specific attribute (one at a time).
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "CodeMismatchException",
"documentation" : "This exception is thrown if the provided code does not match what the server was expecting.
"
}, {
"exceptionName" : "ExpiredCodeException",
"documentation" : "This exception is thrown if a code has expired.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UnexpectedLambdaException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
"
}, {
"exceptionName" : "UserLambdaValidationException",
"documentation" : "This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
"
}, {
"exceptionName" : "InvalidLambdaResponseException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "AliasExistsException",
"documentation" : "This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
}, {
"exceptionName" : "CodeDeliveryFailureException",
"documentation" : "This exception is thrown when a verification code fails to deliver successfully.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateUserAttributesRequest",
"variableName" : "updateUserAttributesRequest",
"variableType" : "UpdateUserAttributesRequest",
"documentation" : "Represents the request to update user attributes.
",
"simpleType" : "UpdateUserAttributesRequest",
"variableSetterType" : "UpdateUserAttributesRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateUserAttributes",
"operationName" : "UpdateUserAttributes",
"returnType" : {
"returnType" : "UpdateUserAttributesResult",
"documentation" : "Represents the response from the server for the request to update user attributes.
"
},
"syncReturnType" : "UpdateUserAttributesResult"
},
"UpdateUserPool" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateUserPoolResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the specified user pool with the specified attributes.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "ConcurrentModificationException",
"documentation" : "This exception is thrown if two or more modifications are happening concurrently.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "UserImportInProgressException",
"documentation" : "This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
}, {
"exceptionName" : "InvalidSmsRoleAccessPolicyException",
"documentation" : "This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.
"
}, {
"exceptionName" : "InvalidSmsRoleTrustRelationshipException",
"documentation" : "This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.
"
}, {
"exceptionName" : "InvalidEmailRoleAccessPolicyException",
"documentation" : "This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateUserPoolRequest",
"variableName" : "updateUserPoolRequest",
"variableType" : "UpdateUserPoolRequest",
"documentation" : "Represents the request to update the user pool.
",
"simpleType" : "UpdateUserPoolRequest",
"variableSetterType" : "UpdateUserPoolRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateUserPool",
"operationName" : "UpdateUserPool",
"returnType" : {
"returnType" : "UpdateUserPoolResult",
"documentation" : "Represents the response from the server when you make a request to update the user pool.
"
},
"syncReturnType" : "UpdateUserPoolResult"
},
"UpdateUserPoolClient" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "UpdateUserPoolClientResult",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Allows the developer to update the specified user pool client and password policy.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateUserPoolClientRequest",
"variableName" : "updateUserPoolClientRequest",
"variableType" : "UpdateUserPoolClientRequest",
"documentation" : "Represents the request to update the user pool client.
",
"simpleType" : "UpdateUserPoolClientRequest",
"variableSetterType" : "UpdateUserPoolClientRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "updateUserPoolClient",
"operationName" : "UpdateUserPoolClient",
"returnType" : {
"returnType" : "UpdateUserPoolClientResult",
"documentation" : "Represents the response from the server to the request to update the user pool client.
"
},
"syncReturnType" : "UpdateUserPoolClientResult"
},
"VerifyUserAttribute" : {
"asyncCallableType" : "java.util.concurrent.Callable",
"asyncFutureType" : "java.util.concurrent.Future",
"asyncHandlerType" : "com.amazonaws.handlers.AsyncHandler",
"asyncReturnType" : "VerifyUserAttributeResult",
"authenticated" : false,
"deprecated" : false,
"documentation" : "Verifies the specified user attributes in the user pool.
",
"exceptions" : [ {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when the Amazon Cognito service cannot find the requested resource.
"
}, {
"exceptionName" : "InvalidParameterException",
"documentation" : "This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
"
}, {
"exceptionName" : "CodeMismatchException",
"documentation" : "This exception is thrown if the provided code does not match what the server was expecting.
"
}, {
"exceptionName" : "ExpiredCodeException",
"documentation" : "This exception is thrown if a code has expired.
"
}, {
"exceptionName" : "NotAuthorizedException",
"documentation" : "This exception gets thrown when a user is not authorized.
"
}, {
"exceptionName" : "TooManyRequestsException",
"documentation" : "This exception gets thrown when the user has made too many requests for a given operation.
"
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "This exception is thrown when a user exceeds the limit for a requested AWS resource.
"
}, {
"exceptionName" : "PasswordResetRequiredException",
"documentation" : "This exception is thrown when a password reset is required.
"
}, {
"exceptionName" : "UserNotFoundException",
"documentation" : "This exception is thrown when a user is not found.
"
}, {
"exceptionName" : "UserNotConfirmedException",
"documentation" : "This exception is thrown when a user is not confirmed successfully.
"
}, {
"exceptionName" : "InternalErrorException",
"documentation" : "This exception is thrown when Amazon Cognito encounters an internal error.
"
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "VerifyUserAttributeRequest",
"variableName" : "verifyUserAttributeRequest",
"variableType" : "VerifyUserAttributeRequest",
"documentation" : "Represents the request to verify user attributes.
",
"simpleType" : "VerifyUserAttributeRequest",
"variableSetterType" : "VerifyUserAttributeRequest"
},
"inputStreamPropertyName" : null,
"methodName" : "verifyUserAttribute",
"operationName" : "VerifyUserAttribute",
"returnType" : {
"returnType" : "VerifyUserAttributeResult",
"documentation" : "A container representing the response from the server from the request to verify user attributes.
"
},
"syncReturnType" : "VerifyUserAttributeResult"
}
},
"shapes" : {
"AddCustomAttributesRequest" : {
"c2jName" : "AddCustomAttributesRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the request to add custom attributes.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "AddCustomAttributes",
"locationName" : null,
"requestUri" : "/",
"target" : "AWSCognitoIdentityProviderService.AddCustomAttributes",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for the user pool where you want to add custom attributes.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@param userPoolId The user pool ID for the user pool where you want to add custom attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@return The user pool ID for the user pool where you want to add custom attributes.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@param userPoolId The user pool ID for the user pool where you want to add custom attributes.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@param userPoolId The user pool ID for the user pool where you want to add custom attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for the user pool where you want to add custom attributes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "CustomAttributes",
"c2jShape" : "CustomAttributesListType",
"deprecated" : false,
"documentation" : "An array of custom attributes, such as Mutable and Name.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\n@param customAttributes An array of custom attributes, such as Mutable and Name.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\n@return An array of custom attributes, such as Mutable and Name.*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "CustomAttributes",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomAttributes",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "SchemaAttributeType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "SchemaAttributeType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "SchemaAttributeType",
"variableName" : "member",
"variableType" : "SchemaAttributeType",
"documentation" : "",
"simpleType" : "SchemaAttributeType",
"variableSetterType" : "SchemaAttributeType"
},
"simple" : false,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "SchemaAttributeType",
"variableName" : "member",
"variableType" : "SchemaAttributeType",
"documentation" : "",
"simpleType" : "SchemaAttributeType",
"variableSetterType" : "SchemaAttributeType"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "SchemaAttributeType",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"simpleType" : "SchemaAttributeType",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "CustomAttributes",
"setterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\n@param customAttributes An array of custom attributes, such as Mutable and Name.*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customAttributes",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setCustomAttributes(java.util.Collection)} or {@link #withCustomAttributes(java.util.Collection)} if you want to override the existing values.
\n@param customAttributes An array of custom attributes, such as Mutable and Name.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customAttributes",
"variableType" : "java.util.List",
"documentation" : "An array of custom attributes, such as Mutable and Name.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"CustomAttributes" : {
"c2jName" : "CustomAttributes",
"c2jShape" : "CustomAttributesListType",
"deprecated" : false,
"documentation" : "An array of custom attributes, such as Mutable and Name.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\n@param customAttributes An array of custom attributes, such as Mutable and Name.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\n@return An array of custom attributes, such as Mutable and Name.*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "CustomAttributes",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "CustomAttributes",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "SchemaAttributeType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "SchemaAttributeType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "SchemaAttributeType",
"variableName" : "member",
"variableType" : "SchemaAttributeType",
"documentation" : "",
"simpleType" : "SchemaAttributeType",
"variableSetterType" : "SchemaAttributeType"
},
"simple" : false,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "SchemaAttributeType",
"variableName" : "member",
"variableType" : "SchemaAttributeType",
"documentation" : "",
"simpleType" : "SchemaAttributeType",
"variableSetterType" : "SchemaAttributeType"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "SchemaAttributeType",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"simpleType" : "SchemaAttributeType",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "CustomAttributes",
"setterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\n@param customAttributes An array of custom attributes, such as Mutable and Name.*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customAttributes",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**An array of custom attributes, such as Mutable and Name.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setCustomAttributes(java.util.Collection)} or {@link #withCustomAttributes(java.util.Collection)} if you want to override the existing values.
\n@param customAttributes An array of custom attributes, such as Mutable and Name.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "customAttributes",
"variableType" : "java.util.List",
"documentation" : "An array of custom attributes, such as Mutable and Name.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
},
"UserPoolId" : {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for the user pool where you want to add custom attributes.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@param userPoolId The user pool ID for the user pool where you want to add custom attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@return The user pool ID for the user pool where you want to add custom attributes.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@param userPoolId The user pool ID for the user pool where you want to add custom attributes.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for the user pool where you want to add custom attributes.
\n@param userPoolId The user pool ID for the user pool where you want to add custom attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for the user pool where you want to add custom attributes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "UserPoolId", "CustomAttributes" ],
"shapeName" : "AddCustomAttributesRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "AddCustomAttributesRequest",
"variableName" : "addCustomAttributesRequest",
"variableType" : "AddCustomAttributesRequest",
"documentation" : null,
"simpleType" : "AddCustomAttributesRequest",
"variableSetterType" : "AddCustomAttributesRequest"
},
"wrapper" : false
},
"AddCustomAttributesResult" : {
"c2jName" : "AddCustomAttributesResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the response from the server for the request to add custom attributes.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "AddCustomAttributesResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AddCustomAttributesResult",
"variableName" : "addCustomAttributesResult",
"variableType" : "AddCustomAttributesResult",
"documentation" : null,
"simpleType" : "AddCustomAttributesResult",
"variableSetterType" : "AddCustomAttributesResult"
},
"wrapper" : false
},
"AdminConfirmSignUpRequest" : {
"c2jName" : "AdminConfirmSignUpRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the request to confirm user registration.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "AdminConfirmSignUp",
"locationName" : null,
"requestUri" : "/",
"target" : "AWSCognitoIdentityProviderService.AdminConfirmSignUp",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for which you want to confirm user registration.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@param userPoolId The user pool ID for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@return The user pool ID for which you want to confirm user registration.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@param userPoolId The user pool ID for which you want to confirm user registration.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@param userPoolId The user pool ID for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for which you want to confirm user registration.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Username",
"c2jShape" : "UsernameType",
"deprecated" : false,
"documentation" : "The user name for which you want to confirm user registration.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@param username The user name for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@return The user name for which you want to confirm user registration.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Username",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Username",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Username",
"setterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@param username The user name for which you want to confirm user registration.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@param username The user name for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "The user name for which you want to confirm user registration.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"UserPoolId" : {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for which you want to confirm user registration.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@param userPoolId The user pool ID for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@return The user pool ID for which you want to confirm user registration.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@param userPoolId The user pool ID for which you want to confirm user registration.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for which you want to confirm user registration.
\n@param userPoolId The user pool ID for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for which you want to confirm user registration.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Username" : {
"c2jName" : "Username",
"c2jShape" : "UsernameType",
"deprecated" : false,
"documentation" : "The user name for which you want to confirm user registration.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@param username The user name for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@return The user name for which you want to confirm user registration.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Username",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Username",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Username",
"setterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@param username The user name for which you want to confirm user registration.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user name for which you want to confirm user registration.
\n@param username The user name for which you want to confirm user registration.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "The user name for which you want to confirm user registration.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "UserPoolId", "Username" ],
"shapeName" : "AdminConfirmSignUpRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "AdminConfirmSignUpRequest",
"variableName" : "adminConfirmSignUpRequest",
"variableType" : "AdminConfirmSignUpRequest",
"documentation" : null,
"simpleType" : "AdminConfirmSignUpRequest",
"variableSetterType" : "AdminConfirmSignUpRequest"
},
"wrapper" : false
},
"AdminConfirmSignUpResult" : {
"c2jName" : "AdminConfirmSignUpResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the response from the server for the request to confirm registration.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : null,
"membersAsMap" : { },
"required" : null,
"shapeName" : "AdminConfirmSignUpResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AdminConfirmSignUpResult",
"variableName" : "adminConfirmSignUpResult",
"variableType" : "AdminConfirmSignUpResult",
"documentation" : null,
"simpleType" : "AdminConfirmSignUpResult",
"variableSetterType" : "AdminConfirmSignUpResult"
},
"wrapper" : false
},
"AdminCreateUserConfigType" : {
"c2jName" : "AdminCreateUserConfigType",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "The type of configuration for creating a new user profile.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "AllowAdminCreateUserOnly",
"c2jShape" : "BooleanType",
"deprecated" : false,
"documentation" : "Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@param allowAdminCreateUserOnly Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@return Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.*/",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AllowAdminCreateUserOnly",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AllowAdminCreateUserOnly",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AllowAdminCreateUserOnly",
"setterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@param allowAdminCreateUserOnly Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.*/",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "allowAdminCreateUserOnly",
"variableType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"varargSetterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@param allowAdminCreateUserOnly Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "allowAdminCreateUserOnly",
"variableType" : "Boolean",
"documentation" : "Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "UnusedAccountValidityDays",
"c2jShape" : "AdminCreateUserUnusedAccountValidityDaysType",
"deprecated" : false,
"documentation" : "The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param unusedAccountValidityDays The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@return The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UnusedAccountValidityDays",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UnusedAccountValidityDays",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UnusedAccountValidityDays",
"setterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param unusedAccountValidityDays The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "unusedAccountValidityDays",
"variableType" : "Integer",
"documentation" : "",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param unusedAccountValidityDays The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "unusedAccountValidityDays",
"variableType" : "Integer",
"documentation" : "The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "InviteMessageTemplate",
"c2jShape" : "MessageTemplateType",
"deprecated" : false,
"documentation" : "The message template to be used for the welcome message to new users.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@param inviteMessageTemplate The message template to be used for the welcome message to new users.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@return The message template to be used for the welcome message to new users.*/",
"getterModel" : {
"returnType" : "MessageTemplateType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "InviteMessageTemplate",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "InviteMessageTemplate",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "InviteMessageTemplate",
"setterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@param inviteMessageTemplate The message template to be used for the welcome message to new users.*/",
"setterModel" : {
"variableDeclarationType" : "MessageTemplateType",
"variableName" : "inviteMessageTemplate",
"variableType" : "MessageTemplateType",
"documentation" : "",
"simpleType" : "MessageTemplateType",
"variableSetterType" : "MessageTemplateType"
},
"simple" : false,
"varargSetterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@param inviteMessageTemplate The message template to be used for the welcome message to new users.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "MessageTemplateType",
"variableName" : "inviteMessageTemplate",
"variableType" : "MessageTemplateType",
"documentation" : "The message template to be used for the welcome message to new users.
",
"simpleType" : "MessageTemplateType",
"variableSetterType" : "MessageTemplateType"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"AllowAdminCreateUserOnly" : {
"c2jName" : "AllowAdminCreateUserOnly",
"c2jShape" : "BooleanType",
"deprecated" : false,
"documentation" : "Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@param allowAdminCreateUserOnly Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@return Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.*/",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "AllowAdminCreateUserOnly",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "AllowAdminCreateUserOnly",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "AllowAdminCreateUserOnly",
"setterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@param allowAdminCreateUserOnly Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.*/",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "allowAdminCreateUserOnly",
"variableType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"varargSetterDocumentation" : "/**Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
\n@param allowAdminCreateUserOnly Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "allowAdminCreateUserOnly",
"variableType" : "Boolean",
"documentation" : "Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlNameSpaceUri" : null
},
"InviteMessageTemplate" : {
"c2jName" : "InviteMessageTemplate",
"c2jShape" : "MessageTemplateType",
"deprecated" : false,
"documentation" : "The message template to be used for the welcome message to new users.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@param inviteMessageTemplate The message template to be used for the welcome message to new users.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@return The message template to be used for the welcome message to new users.*/",
"getterModel" : {
"returnType" : "MessageTemplateType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "InviteMessageTemplate",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "InviteMessageTemplate",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "InviteMessageTemplate",
"setterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@param inviteMessageTemplate The message template to be used for the welcome message to new users.*/",
"setterModel" : {
"variableDeclarationType" : "MessageTemplateType",
"variableName" : "inviteMessageTemplate",
"variableType" : "MessageTemplateType",
"documentation" : "",
"simpleType" : "MessageTemplateType",
"variableSetterType" : "MessageTemplateType"
},
"simple" : false,
"varargSetterDocumentation" : "/**The message template to be used for the welcome message to new users.
\n@param inviteMessageTemplate The message template to be used for the welcome message to new users.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "MessageTemplateType",
"variableName" : "inviteMessageTemplate",
"variableType" : "MessageTemplateType",
"documentation" : "The message template to be used for the welcome message to new users.
",
"simpleType" : "MessageTemplateType",
"variableSetterType" : "MessageTemplateType"
},
"xmlNameSpaceUri" : null
},
"UnusedAccountValidityDays" : {
"c2jName" : "UnusedAccountValidityDays",
"c2jShape" : "AdminCreateUserUnusedAccountValidityDaysType",
"deprecated" : false,
"documentation" : "The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param unusedAccountValidityDays The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@return The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UnusedAccountValidityDays",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UnusedAccountValidityDays",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UnusedAccountValidityDays",
"setterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param unusedAccountValidityDays The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "unusedAccountValidityDays",
"variableType" : "Integer",
"documentation" : "",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param unusedAccountValidityDays The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "unusedAccountValidityDays",
"variableType" : "Integer",
"documentation" : "The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "AdminCreateUserConfigType",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AdminCreateUserConfigType",
"variableName" : "adminCreateUserConfigType",
"variableType" : "AdminCreateUserConfigType",
"documentation" : null,
"simpleType" : "AdminCreateUserConfigType",
"variableSetterType" : "AdminCreateUserConfigType"
},
"wrapper" : false
},
"AdminCreateUserRequest" : {
"c2jName" : "AdminCreateUserRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the request to create a user in the specified user pool.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "AdminCreateUser",
"locationName" : null,
"requestUri" : "/",
"target" : "AWSCognitoIdentityProviderService.AdminCreateUser",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for the user pool where the user will be created.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@param userPoolId The user pool ID for the user pool where the user will be created.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@return The user pool ID for the user pool where the user will be created.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@param userPoolId The user pool ID for the user pool where the user will be created.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@param userPoolId The user pool ID for the user pool where the user will be created.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for the user pool where the user will be created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Username",
"c2jShape" : "UsernameType",
"deprecated" : false,
"documentation" : "The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@param username The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@return The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Username",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Username",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Username",
"setterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@param username The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@param username The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "UserAttributes",
"c2jShape" : "AttributeListType",
"deprecated" : false,
"documentation" : "An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@param userAttributes An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@return An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserAttributes",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserAttributes",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "AttributeType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "AttributeType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"simple" : false,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "AttributeType",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"simpleType" : "AttributeType",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "UserAttributes",
"setterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@param userAttributes An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "userAttributes",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setUserAttributes(java.util.Collection)} or {@link #withUserAttributes(java.util.Collection)} if you want to override the existing values.
\n@param userAttributes An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "userAttributes",
"variableType" : "java.util.List",
"documentation" : "An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "ValidationData",
"c2jShape" : "AttributeListType",
"deprecated" : false,
"documentation" : "The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\n@param validationData The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\n@return The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "ValidationData",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "ValidationData",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "AttributeType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "AttributeType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"simple" : false,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "AttributeType",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"simpleType" : "AttributeType",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "ValidationData",
"setterDocumentation" : "/**The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\n@param validationData The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "validationData",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setValidationData(java.util.Collection)} or {@link #withValidationData(java.util.Collection)} if you want to override the existing values.
\n@param validationData The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "validationData",
"variableType" : "java.util.List",
"documentation" : "The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "TemporaryPassword",
"c2jShape" : "PasswordType",
"deprecated" : false,
"documentation" : "The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param temporaryPassword The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@return The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "TemporaryPassword",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "TemporaryPassword",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "TemporaryPassword",
"setterDocumentation" : "/**
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param temporaryPassword The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "temporaryPassword",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param temporaryPassword The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "temporaryPassword",
"variableType" : "String",
"documentation" : "
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "ForceAliasCreation",
"c2jShape" : "ForceAliasCreation",
"deprecated" : false,
"documentation" : "This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@param forceAliasCreation This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@return This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.*/",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "ForceAliasCreation",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "ForceAliasCreation",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "ForceAliasCreation",
"setterDocumentation" : "/**
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@param forceAliasCreation This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.*/",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "forceAliasCreation",
"variableType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"varargSetterDocumentation" : "/**
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@param forceAliasCreation This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "forceAliasCreation",
"variableType" : "Boolean",
"documentation" : "
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "MessageAction",
"c2jShape" : "MessageActionType",
"deprecated" : false,
"documentation" : "Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
",
"enumType" : "MessageActionType",
"fluentSetterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@param messageAction Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see MessageActionType*/",
"getterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@return Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@see MessageActionType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "MessageAction",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "MessageAction",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "MessageAction",
"setterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@param messageAction Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@see MessageActionType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "messageAction",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@param messageAction Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see MessageActionType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "messageAction",
"variableType" : "String",
"documentation" : "Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "DesiredDeliveryMediums",
"c2jShape" : "DeliveryMediumListType",
"deprecated" : false,
"documentation" : "Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
",
"enumType" : "DeliveryMediumType",
"fluentSetterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\n@param desiredDeliveryMediums Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"getterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\n@return Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@see DeliveryMediumType*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "DesiredDeliveryMediums",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "DesiredDeliveryMediums",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "DeliveryMediumType",
"deprecated" : false,
"documentation" : "",
"enumType" : "DeliveryMediumType",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"getterDocumentation" : "/**\n@return \n@see DeliveryMediumType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member \n@see DeliveryMediumType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "DesiredDeliveryMediums",
"setterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\n@param desiredDeliveryMediums Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@see DeliveryMediumType*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "desiredDeliveryMediums",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setDesiredDeliveryMediums(java.util.Collection)} or {@link #withDesiredDeliveryMediums(java.util.Collection)} if you want to override the existing values.
\n@param desiredDeliveryMediums Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "desiredDeliveryMediums",
"variableType" : "java.util.List",
"documentation" : "Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"DesiredDeliveryMediums" : {
"c2jName" : "DesiredDeliveryMediums",
"c2jShape" : "DeliveryMediumListType",
"deprecated" : false,
"documentation" : "Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
",
"enumType" : "DeliveryMediumType",
"fluentSetterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\n@param desiredDeliveryMediums Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"getterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\n@return Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@see DeliveryMediumType*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "DesiredDeliveryMediums",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "DesiredDeliveryMediums",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "DeliveryMediumType",
"deprecated" : false,
"documentation" : "",
"enumType" : "DeliveryMediumType",
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"getterDocumentation" : "/**\n@return \n@see DeliveryMediumType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member \n@see DeliveryMediumType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "DesiredDeliveryMediums",
"setterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\n@param desiredDeliveryMediums Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@see DeliveryMediumType*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "desiredDeliveryMediums",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setDesiredDeliveryMediums(java.util.Collection)} or {@link #withDesiredDeliveryMediums(java.util.Collection)} if you want to override the existing values.
\n@param desiredDeliveryMediums Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see DeliveryMediumType*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "desiredDeliveryMediums",
"variableType" : "java.util.List",
"documentation" : "Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
},
"ForceAliasCreation" : {
"c2jName" : "ForceAliasCreation",
"c2jShape" : "ForceAliasCreation",
"deprecated" : false,
"documentation" : "This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@param forceAliasCreation This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@return This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.*/",
"getterModel" : {
"returnType" : "Boolean",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "ForceAliasCreation",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "ForceAliasCreation",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "ForceAliasCreation",
"setterDocumentation" : "/**
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@param forceAliasCreation This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.*/",
"setterModel" : {
"variableDeclarationType" : "Boolean",
"variableName" : "forceAliasCreation",
"variableType" : "Boolean",
"documentation" : "",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"simple" : true,
"varargSetterDocumentation" : "/**
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
\n@param forceAliasCreation This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "Boolean",
"variableName" : "forceAliasCreation",
"variableType" : "Boolean",
"documentation" : "
This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.
If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.
If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
",
"simpleType" : "Boolean",
"variableSetterType" : "Boolean"
},
"xmlNameSpaceUri" : null
},
"MessageAction" : {
"c2jName" : "MessageAction",
"c2jShape" : "MessageActionType",
"deprecated" : false,
"documentation" : "Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
",
"enumType" : "MessageActionType",
"fluentSetterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@param messageAction Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see MessageActionType*/",
"getterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@return Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@see MessageActionType*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "MessageAction",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "MessageAction",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "MessageAction",
"setterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@param messageAction Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@see MessageActionType*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "messageAction",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
\n@param messageAction Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@see MessageActionType*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "messageAction",
"variableType" : "String",
"documentation" : "Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"TemporaryPassword" : {
"c2jName" : "TemporaryPassword",
"c2jShape" : "PasswordType",
"deprecated" : false,
"documentation" : "The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param temporaryPassword The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@return The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "TemporaryPassword",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "TemporaryPassword",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "TemporaryPassword",
"setterDocumentation" : "/**
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param temporaryPassword The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "temporaryPassword",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
\n@param temporaryPassword The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "temporaryPassword",
"variableType" : "String",
"documentation" : "
The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.
The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.
This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"UserAttributes" : {
"c2jName" : "UserAttributes",
"c2jShape" : "AttributeListType",
"deprecated" : false,
"documentation" : "An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@param userAttributes An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@return An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserAttributes",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserAttributes",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "AttributeType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "AttributeType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"simple" : false,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "AttributeType",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"simpleType" : "AttributeType",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "UserAttributes",
"setterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@param userAttributes An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "userAttributes",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setUserAttributes(java.util.Collection)} or {@link #withUserAttributes(java.util.Collection)} if you want to override the existing values.
\n@param userAttributes An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "userAttributes",
"variableType" : "java.util.List",
"documentation" : "An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).
To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.
In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)
-
email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.
-
phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
},
"UserPoolId" : {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for the user pool where the user will be created.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@param userPoolId The user pool ID for the user pool where the user will be created.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@return The user pool ID for the user pool where the user will be created.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@param userPoolId The user pool ID for the user pool where the user will be created.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for the user pool where the user will be created.
\n@param userPoolId The user pool ID for the user pool where the user will be created.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for the user pool where the user will be created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Username" : {
"c2jName" : "Username",
"c2jShape" : "UsernameType",
"deprecated" : false,
"documentation" : "The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@param username The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@return The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Username",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Username",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Username",
"setterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@param username The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
\n@param username The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"ValidationData" : {
"c2jName" : "ValidationData",
"c2jShape" : "AttributeListType",
"deprecated" : false,
"documentation" : "The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\n@param validationData The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**
The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\n@return The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "ValidationData",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "ValidationData",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "AttributeType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "AttributeType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"simple" : false,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "AttributeType",
"variableName" : "member",
"variableType" : "AttributeType",
"documentation" : "",
"simpleType" : "AttributeType",
"variableSetterType" : "AttributeType"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "AttributeType",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : false,
"simpleType" : "AttributeType",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"name" : "ValidationData",
"setterDocumentation" : "/**The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\n@param validationData The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.*/",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "validationData",
"variableType" : "java.util.List",
"documentation" : "",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"varargSetterDocumentation" : "/**The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setValidationData(java.util.Collection)} or {@link #withValidationData(java.util.Collection)} if you want to override the existing values.
\n@param validationData The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "validationData",
"variableType" : "java.util.List",
"documentation" : "The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.
The user's validation data is not persisted.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlNameSpaceUri" : null
}
},
"required" : [ "UserPoolId", "Username" ],
"shapeName" : "AdminCreateUserRequest",
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "AdminCreateUserRequest",
"variableName" : "adminCreateUserRequest",
"variableType" : "AdminCreateUserRequest",
"documentation" : null,
"simpleType" : "AdminCreateUserRequest",
"variableSetterType" : "AdminCreateUserRequest"
},
"wrapper" : false
},
"AdminCreateUserResult" : {
"c2jName" : "AdminCreateUserResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the response from the server to the request to create the user.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : null,
"members" : [ {
"c2jName" : "User",
"c2jShape" : "UserType",
"deprecated" : false,
"documentation" : "The user returned in the request to create a new user.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user returned in the request to create a new user.
\n@param user The user returned in the request to create a new user.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user returned in the request to create a new user.
\n@return The user returned in the request to create a new user.*/",
"getterModel" : {
"returnType" : "UserType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "User",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "User",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "User",
"setterDocumentation" : "/**The user returned in the request to create a new user.
\n@param user The user returned in the request to create a new user.*/",
"setterModel" : {
"variableDeclarationType" : "UserType",
"variableName" : "user",
"variableType" : "UserType",
"documentation" : "",
"simpleType" : "UserType",
"variableSetterType" : "UserType"
},
"simple" : false,
"varargSetterDocumentation" : "/**The user returned in the request to create a new user.
\n@param user The user returned in the request to create a new user.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "UserType",
"variableName" : "user",
"variableType" : "UserType",
"documentation" : "The user returned in the request to create a new user.
",
"simpleType" : "UserType",
"variableSetterType" : "UserType"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"User" : {
"c2jName" : "User",
"c2jShape" : "UserType",
"deprecated" : false,
"documentation" : "The user returned in the request to create a new user.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user returned in the request to create a new user.
\n@param user The user returned in the request to create a new user.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user returned in the request to create a new user.
\n@return The user returned in the request to create a new user.*/",
"getterModel" : {
"returnType" : "UserType",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "User",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "User",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "User",
"setterDocumentation" : "/**The user returned in the request to create a new user.
\n@param user The user returned in the request to create a new user.*/",
"setterModel" : {
"variableDeclarationType" : "UserType",
"variableName" : "user",
"variableType" : "UserType",
"documentation" : "",
"simpleType" : "UserType",
"variableSetterType" : "UserType"
},
"simple" : false,
"varargSetterDocumentation" : "/**The user returned in the request to create a new user.
\n@param user The user returned in the request to create a new user.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "UserType",
"variableName" : "user",
"variableType" : "UserType",
"documentation" : "The user returned in the request to create a new user.
",
"simpleType" : "UserType",
"variableSetterType" : "UserType"
},
"xmlNameSpaceUri" : null
}
},
"required" : null,
"shapeName" : "AdminCreateUserResult",
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "AdminCreateUserResult",
"variableName" : "adminCreateUserResult",
"variableType" : "AdminCreateUserResult",
"documentation" : null,
"simpleType" : "AdminCreateUserResult",
"variableSetterType" : "AdminCreateUserResult"
},
"wrapper" : false
},
"AdminDeleteUserAttributesRequest" : {
"c2jName" : "AdminDeleteUserAttributesRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false
},
"deprecated" : false,
"documentation" : "Represents the request to delete user attributes as an administrator.
",
"enums" : null,
"errorCode" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"marshaller" : {
"action" : "AdminDeleteUserAttributes",
"locationName" : null,
"requestUri" : "/",
"target" : "AWSCognitoIdentityProviderService.AdminDeleteUserAttributes",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"c2jName" : "UserPoolId",
"c2jShape" : "UserPoolIdType",
"deprecated" : false,
"documentation" : "The user pool ID for the user pool where you want to delete user attributes.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user pool ID for the user pool where you want to delete user attributes.
\n@param userPoolId The user pool ID for the user pool where you want to delete user attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user pool ID for the user pool where you want to delete user attributes.
\n@return The user pool ID for the user pool where you want to delete user attributes.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserPoolId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserPoolId",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "UserPoolId",
"setterDocumentation" : "/**The user pool ID for the user pool where you want to delete user attributes.
\n@param userPoolId The user pool ID for the user pool where you want to delete user attributes.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user pool ID for the user pool where you want to delete user attributes.
\n@param userPoolId The user pool ID for the user pool where you want to delete user attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userPoolId",
"variableType" : "String",
"documentation" : "The user pool ID for the user pool where you want to delete user attributes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "Username",
"c2jShape" : "UsernameType",
"deprecated" : false,
"documentation" : "The user name of the user from which you would like to delete attributes.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**The user name of the user from which you would like to delete attributes.
\n@param username The user name of the user from which you would like to delete attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**The user name of the user from which you would like to delete attributes.
\n@return The user name of the user from which you would like to delete attributes.*/",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "Username",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Username",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Username",
"setterDocumentation" : "/**The user name of the user from which you would like to delete attributes.
\n@param username The user name of the user from which you would like to delete attributes.*/",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**The user name of the user from which you would like to delete attributes.
\n@param username The user name of the user from which you would like to delete attributes.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "username",
"variableType" : "String",
"documentation" : "The user name of the user from which you would like to delete attributes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
}, {
"c2jName" : "UserAttributeNames",
"c2jShape" : "AttributeNameListType",
"deprecated" : false,
"documentation" : "An array of strings representing the user attribute names you wish to delete.
",
"enumType" : null,
"fluentSetterDocumentation" : "/**An array of strings representing the user attribute names you wish to delete.
\n@param userAttributeNames An array of strings representing the user attribute names you wish to delete.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**An array of strings representing the user attribute names you wish to delete.
\n@return An array of strings representing the user attribute names you wish to delete.*/",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "UserAttributeNames",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserAttributeNames",
"uri" : false
},
"idempotencyToken" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"c2jName" : "member",
"c2jShape" : "AttributeNameType",
"deprecated" : false,
"documentation" : "",
"enumType" : null,
"fluentSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"getterDocumentation" : "/**\n@return */",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocationName" : "member",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"name" : "Member",
"setterDocumentation" : "/**\n@param member */",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"varargSetterDocumentation" : "/**\n@param member \n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "member",
"variableType" : "String",
"documentation" : "",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "String",
"map" : false,
"marshallNonAutoConstructedEmptyLists" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"sendEmptyQueryString" : false,
"simple" : true,
"simpleType" : "String",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List