{ "metadata": { "apiVersion": "2020-08-11", "endpointPrefix": "amplifybackend", "signingName": "amplifybackend", "serviceFullName": "AmplifyBackend", "serviceId": "AmplifyBackend", "protocol": "rest-json", "jsonVersion": "1.1", "uid": "amplifybackend-2020-08-11", "signatureVersion": "v4" }, "operations": { "CloneBackend": { "name": "CloneBackend", "http": { "method": "POST", "requestUri": "/backend/{appId}/environments/{backendEnvironmentName}/clone", "responseCode": 200 }, "input": { "shape": "CloneBackendRequest" }, "output": { "shape": "CloneBackendResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

This operation clones an existing backend.

" }, "CreateBackend": { "name": "CreateBackend", "http": { "method": "POST", "requestUri": "/backend", "responseCode": 200 }, "input": { "shape": "CreateBackendRequest" }, "output": { "shape": "CreateBackendResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

" }, "CreateBackendAPI": { "name": "CreateBackendAPI", "http": { "method": "POST", "requestUri": "/backend/{appId}/api", "responseCode": 200 }, "input": { "shape": "CreateBackendAPIRequest" }, "output": { "shape": "CreateBackendAPIResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Creates a new backend API resource.

" }, "CreateBackendAuth": { "name": "CreateBackendAuth", "http": { "method": "POST", "requestUri": "/backend/{appId}/auth", "responseCode": 200 }, "input": { "shape": "CreateBackendAuthRequest" }, "output": { "shape": "CreateBackendAuthResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Creates a new backend authentication resource.

" }, "CreateBackendConfig": { "name": "CreateBackendConfig", "http": { "method": "POST", "requestUri": "/backend/{appId}/config", "responseCode": 200 }, "input": { "shape": "CreateBackendConfigRequest" }, "output": { "shape": "CreateBackendConfigResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Creates a config object for a backend.

" }, "CreateToken": { "name": "CreateToken", "http": { "method": "POST", "requestUri": "/backend/{appId}/challenge", "responseCode": 200 }, "input": { "shape": "CreateTokenRequest" }, "output": { "shape": "CreateTokenResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

" }, "DeleteBackend": { "name": "DeleteBackend", "http": { "method": "POST", "requestUri": "/backend/{appId}/environments/{backendEnvironmentName}/remove", "responseCode": 200 }, "input": { "shape": "DeleteBackendRequest" }, "output": { "shape": "DeleteBackendResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Removes an existing environment from your Amplify project.

" }, "DeleteBackendAPI": { "name": "DeleteBackendAPI", "http": { "method": "POST", "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/remove", "responseCode": 200 }, "input": { "shape": "DeleteBackendAPIRequest" }, "output": { "shape": "DeleteBackendAPIResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Deletes an existing backend API resource.

" }, "DeleteBackendAuth": { "name": "DeleteBackendAuth", "http": { "method": "POST", "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}/remove", "responseCode": 200 }, "input": { "shape": "DeleteBackendAuthRequest" }, "output": { "shape": "DeleteBackendAuthResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Deletes an existing backend authentication resource.

" }, "DeleteToken": { "name": "DeleteToken", "http": { "method": "POST", "requestUri": "/backend/{appId}/challenge/{sessionId}/remove", "responseCode": 200 }, "input": { "shape": "DeleteTokenRequest" }, "output": { "shape": "DeleteTokenResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Deletes the challenge token based on the given appId and sessionId.

" }, "GenerateBackendAPIModels": { "name": "GenerateBackendAPIModels", "http": { "method": "POST", "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/generateModels", "responseCode": 200 }, "input": { "shape": "GenerateBackendAPIModelsRequest" }, "output": { "shape": "GenerateBackendAPIModelsResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Generates a model schema for an existing backend API resource.

" }, "GetBackend": { "name": "GetBackend", "http": { "method": "POST", "requestUri": "/backend/{appId}/details", "responseCode": 200 }, "input": { "shape": "GetBackendRequest" }, "output": { "shape": "GetBackendResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Provides project-level details for your Amplify UI project.

" }, "GetBackendAPI": { "name": "GetBackendAPI", "http": { "method": "POST", "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/details", "responseCode": 200 }, "input": { "shape": "GetBackendAPIRequest" }, "output": { "shape": "GetBackendAPIResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Gets the details for a backend API.

" }, "GetBackendAPIModels": { "name": "GetBackendAPIModels", "http": { "method": "POST", "requestUri": "/backend/{appId}/api/{backendEnvironmentName}/getModels", "responseCode": 200 }, "input": { "shape": "GetBackendAPIModelsRequest" }, "output": { "shape": "GetBackendAPIModelsResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Generates a model schema for existing backend API resource.

" }, "GetBackendAuth": { "name": "GetBackendAuth", "http": { "method": "POST", "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}/details", "responseCode": 200 }, "input": { "shape": "GetBackendAuthRequest" }, "output": { "shape": "GetBackendAuthResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Gets a backend auth details.

" }, "GetBackendJob": { "name": "GetBackendJob", "http": { "method": "GET", "requestUri": "/backend/{appId}/job/{backendEnvironmentName}/{jobId}", "responseCode": 200 }, "input": { "shape": "GetBackendJobRequest" }, "output": { "shape": "GetBackendJobResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Returns information about a specific job.

" }, "GetToken": { "name": "GetToken", "http": { "method": "GET", "requestUri": "/backend/{appId}/challenge/{sessionId}", "responseCode": 200 }, "input": { "shape": "GetTokenRequest" }, "output": { "shape": "GetTokenResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Gets the challenge token based on the given appId and sessionId.

" }, "ImportBackendAuth": { "name": "ImportBackendAuth", "http": { "method": "POST", "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}/import", "responseCode": 200 }, "input": { "shape": "ImportBackendAuthRequest" }, "output": { "shape": "ImportBackendAuthResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Imports an existing backend authentication resource.

" }, "ListBackendJobs": { "name": "ListBackendJobs", "http": { "method": "POST", "requestUri": "/backend/{appId}/job/{backendEnvironmentName}", "responseCode": 200 }, "input": { "shape": "ListBackendJobsRequest" }, "output": { "shape": "ListBackendJobsResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Lists the jobs for the backend of an Amplify app.

" }, "RemoveAllBackends": { "name": "RemoveAllBackends", "http": { "method": "POST", "requestUri": "/backend/{appId}/remove", "responseCode": 200 }, "input": { "shape": "RemoveAllBackendsRequest" }, "output": { "shape": "RemoveAllBackendsResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Removes all backend environments from your Amplify project.

" }, "RemoveBackendConfig": { "name": "RemoveBackendConfig", "http": { "method": "POST", "requestUri": "/backend/{appId}/config/remove", "responseCode": 200 }, "input": { "shape": "RemoveBackendConfigRequest" }, "output": { "shape": "RemoveBackendConfigResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Removes the AWS resources required to access the Amplify Admin UI.

" }, "UpdateBackendAPI": { "name": "UpdateBackendAPI", "http": { "method": "POST", "requestUri": "/backend/{appId}/api/{backendEnvironmentName}", "responseCode": 200 }, "input": { "shape": "UpdateBackendAPIRequest" }, "output": { "shape": "UpdateBackendAPIResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Updates an existing backend API resource.

" }, "UpdateBackendAuth": { "name": "UpdateBackendAuth", "http": { "method": "POST", "requestUri": "/backend/{appId}/auth/{backendEnvironmentName}", "responseCode": 200 }, "input": { "shape": "UpdateBackendAuthRequest" }, "output": { "shape": "UpdateBackendAuthResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Updates an existing backend authentication resource.

" }, "UpdateBackendConfig": { "name": "UpdateBackendConfig", "http": { "method": "POST", "requestUri": "/backend/{appId}/config/update", "responseCode": 200 }, "input": { "shape": "UpdateBackendConfigRequest" }, "output": { "shape": "UpdateBackendConfigResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Updates the AWS resources required to access the Amplify Admin UI.

" }, "UpdateBackendJob": { "name": "UpdateBackendJob", "http": { "method": "POST", "requestUri": "/backend/{appId}/job/{backendEnvironmentName}/{jobId}", "responseCode": 200 }, "input": { "shape": "UpdateBackendJobRequest" }, "output": { "shape": "UpdateBackendJobResponse", "documentation": "

200 response

" }, "errors": [ { "shape": "NotFoundException", "documentation": "

404 response

" }, { "shape": "GatewayTimeoutException", "documentation": "

504 response

" }, { "shape": "TooManyRequestsException", "documentation": "

429 response

" }, { "shape": "BadRequestException", "documentation": "

400 response

" } ], "documentation": "

Updates a specific job.

" } }, "shapes": { "AuthResources": { "type": "string", "enum": [ "USER_POOL_ONLY", "IDENTITY_POOL_AND_USER_POOL" ] }, "BackendAPIAppSyncAuthSettings": { "type": "structure", "members": { "CognitoUserPoolId": { "shape": "__string", "locationName": "cognitoUserPoolId", "documentation": "

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

" }, "Description": { "shape": "__string", "locationName": "description", "documentation": "

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

" }, "ExpirationTime": { "shape": "__double", "locationName": "expirationTime", "documentation": "

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

" }, "OpenIDAuthTTL": { "shape": "__string", "locationName": "openIDAuthTTL", "documentation": "

The expiry time for the OpenID authentication mechanism.

" }, "OpenIDClientId": { "shape": "__string", "locationName": "openIDClientId", "documentation": "

The clientID for openID, if openID was used as an authentication setting to access your data models.

" }, "OpenIDIatTTL": { "shape": "__string", "locationName": "openIDIatTTL", "documentation": "

The expiry time for the OpenID authentication mechanism.

" }, "OpenIDIssueURL": { "shape": "__string", "locationName": "openIDIssueURL", "documentation": "

The openID issuer URL, if openID was used as an authentication setting to access your data models.

" }, "OpenIDProviderName": { "shape": "__string", "locationName": "openIDProviderName", "documentation": "

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

" } }, "documentation": "

The authentication settings for accessing provisioned data models in your Amplify project.

" }, "BackendAPIAuthType": { "type": "structure", "members": { "Mode": { "shape": "Mode", "locationName": "mode", "documentation": "

Describes the authentication mode.

" }, "Settings": { "shape": "BackendAPIAppSyncAuthSettings", "locationName": "settings", "documentation": "

Describes settings for the authentication mode.

" } }, "documentation": "

Describes the auth types for your configured data models.

" }, "BackendAPICodegenReqObj": { "type": "structure", "members": { "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName" ] }, "BackendAPICodegenRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object sent when a backend is created.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "BackendAPIConflictResolution": { "type": "structure", "members": { "ResolutionStrategy": { "shape": "ResolutionStrategy", "locationName": "resolutionStrategy", "documentation": "

The strategy for conflict resolution.

" } }, "documentation": "

Describes the conflict resolution configuration for your data model configured in your Amplify project.

" }, "BackendAPIReqObj": { "type": "structure", "members": { "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

Defines the resource configuration for the data model in your Amplify project.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName" ] }, "BackendAPIResourceConfig": { "type": "structure", "members": { "AdditionalAuthTypes": { "shape": "ListOfBackendAPIAuthType", "locationName": "additionalAuthTypes", "documentation": "

Additional authentication methods used to interact with your data models.

" }, "ApiName": { "shape": "__string", "locationName": "apiName", "documentation": "

The API name used to interact with the data model, configured as a part of your Amplify project.

" }, "ConflictResolution": { "shape": "BackendAPIConflictResolution", "locationName": "conflictResolution", "documentation": "

The conflict resolution strategy for your data stored in the data models.

" }, "DefaultAuthType": { "shape": "BackendAPIAuthType", "locationName": "defaultAuthType", "documentation": "

The default authentication type for interacting with the configured data models in your Amplify project.

" }, "Service": { "shape": "__string", "locationName": "service", "documentation": "

The service used to provision and interact with the data model.

" }, "TransformSchema": { "shape": "__string", "locationName": "transformSchema", "documentation": "

The definition of the data model in the annotated transform of the GraphQL schema.

" } }, "documentation": "

The resource config for the data model, configured as a part of the Amplify project.

" }, "BackendAPIRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object sent when a backend is created.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "BackendAuthAppleProviderConfig": { "type": "structure", "members": { "ClientId": { "shape": "__string", "locationName": "client_id", "documentation": "

Describes the client_id (also called Services ID) that comes from Apple.

" }, "KeyId": { "shape": "__string", "locationName": "key_id", "documentation": "

Describes the key_id that comes from Apple.

" }, "PrivateKey": { "shape": "__string", "locationName": "private_key", "documentation": "

Describes the private_key that comes from Apple.

" }, "TeamId": { "shape": "__string", "locationName": "team_id", "documentation": "

Describes the team_id that comes from Apple.

" } }, "documentation": "

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

" }, "BackendAuthRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "BackendAuthSocialProviderConfig": { "type": "structure", "members": { "ClientId": { "shape": "__string", "locationName": "client_id", "documentation": "

Describes the client_id, which can be obtained from the third-party social federation provider.

" }, "ClientSecret": { "shape": "__string", "locationName": "client_secret", "documentation": "

Describes the client_secret, which can be obtained from third-party social federation providers.

" } }, "documentation": "

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

" }, "BackendConfigRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendManagerAppId": { "shape": "__string", "locationName": "backendManagerAppId", "documentation": "

The app ID for the backend manager.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "LoginAuthConfig": { "shape": "LoginAuthConfigReqObj", "locationName": "loginAuthConfig", "documentation": "

Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

" } }, "documentation": "

The response object for this operation.

" }, "BackendJobReqObj": { "type": "structure", "members": { "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

Filters the list of response objects to include only those with the specified operation name.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

Filters the list of response objects to include only those with the specified status.

" } }, "documentation": "

The request object for this operation.

" }, "BackendJobRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "CreateTime": { "shape": "__string", "locationName": "createTime", "documentation": "

The time when the job was created.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" }, "UpdateTime": { "shape": "__string", "locationName": "updateTime", "documentation": "

The time when the job was last updated.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "BadRequestException": { "type": "structure", "members": { "Message": { "shape": "__string", "locationName": "message", "documentation": "

An error message to inform that the request failed.

" } }, "documentation": "

An error returned if a request is not formed properly.

", "exception": true, "error": { "httpStatusCode": 400 } }, "CloneBackendReqObj": { "type": "structure", "members": { "TargetEnvironmentName": { "shape": "__string", "locationName": "targetEnvironmentName", "documentation": "

The name of the destination backend environment to be created.

" } }, "documentation": "

The request object for this operation.

", "required": [ "TargetEnvironmentName" ] }, "CloneBackendRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "TargetEnvironmentName": { "shape": "__string", "locationName": "targetEnvironmentName", "documentation": "

The name of the destination backend environment to be created.

" } }, "documentation": "

The request body for CloneBackend.

", "required": [ "AppId", "BackendEnvironmentName", "TargetEnvironmentName" ] }, "CloneBackendRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object sent when a backend is created.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "CloneBackendResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "CreateBackendAPIReqObj": { "type": "structure", "members": { "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this request.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName", "BackendEnvironmentName", "ResourceConfig" ] }, "CreateBackendAPIRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this request.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for CreateBackendAPI.

", "required": [ "AppId", "ResourceName", "BackendEnvironmentName", "ResourceConfig" ] }, "CreateBackendAPIResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "CreateBackendAuthForgotPasswordConfig": { "type": "structure", "members": { "DeliveryMethod": { "shape": "DeliveryMethod", "locationName": "deliveryMethod", "documentation": "

Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.

" }, "EmailSettings": { "shape": "EmailSettings", "locationName": "emailSettings", "documentation": "

The configuration for the email sent when an app user forgets their password.

" }, "SmsSettings": { "shape": "SmsSettings", "locationName": "smsSettings", "documentation": "

The configuration for the SMS message sent when an app user forgets their password.

" } }, "documentation": "

Describes the forgot password policy for authenticating into the Amplify app.

", "required": [ "DeliveryMethod" ] }, "CreateBackendAuthIdentityPoolConfig": { "type": "structure", "members": { "IdentityPoolName": { "shape": "__string", "locationName": "identityPoolName", "documentation": "

Name of the Amazon Cognito identity pool used for authorization.

" }, "UnauthenticatedLogin": { "shape": "__boolean", "locationName": "unauthenticatedLogin", "documentation": "

Set to true or false based on whether you want to enable guest authorization to your Amplify app.

" } }, "documentation": "

Describes authorization configurations for the auth resources, configured as a part of your Amplify project.

", "required": [ "UnauthenticatedLogin", "IdentityPoolName" ] }, "CreateBackendAuthMFAConfig": { "type": "structure", "members": { "MFAMode": { "shape": "MFAMode", "documentation": "

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

" }, "Settings": { "shape": "Settings", "locationName": "settings", "documentation": "

Describes the configuration settings and methods for your Amplify app users to use MFA.

" } }, "documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

", "required": [ "MFAMode" ] }, "CreateBackendAuthOAuthConfig": { "type": "structure", "members": { "DomainPrefix": { "shape": "__string", "locationName": "domainPrefix", "documentation": "

The domain prefix for your Amplify app.

" }, "OAuthGrantType": { "shape": "OAuthGrantType", "locationName": "oAuthGrantType", "documentation": "

The OAuth grant type that you use to allow app users to authenticate from your Amplify app.

" }, "OAuthScopes": { "shape": "ListOfOAuthScopesElement", "locationName": "oAuthScopes", "documentation": "

List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.

" }, "RedirectSignInURIs": { "shape": "ListOf__string", "locationName": "redirectSignInURIs", "documentation": "

The redirected URI for signing in to your Amplify app.

" }, "RedirectSignOutURIs": { "shape": "ListOf__string", "locationName": "redirectSignOutURIs", "documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

" }, "SocialProviderSettings": { "shape": "SocialProviderSettings", "locationName": "socialProviderSettings", "documentation": "

The settings for using social providers to access your Amplify app.

" } }, "documentation": "

Creates the OAuth configuration for your Amplify project.

", "required": [ "RedirectSignOutURIs", "RedirectSignInURIs", "OAuthGrantType", "OAuthScopes" ] }, "CreateBackendAuthPasswordPolicyConfig": { "type": "structure", "members": { "AdditionalConstraints": { "shape": "ListOfAdditionalConstraintsElement", "locationName": "additionalConstraints", "documentation": "

Additional constraints for the password used to access the backend of your Amplify project.

" }, "MinimumLength": { "shape": "__double", "locationName": "minimumLength", "documentation": "

The minimum length of the password used to access the backend of your Amplify project.

" } }, "documentation": "

The password policy configuration for the backend to your Amplify project.

", "required": [ "MinimumLength" ] }, "CreateBackendAuthReqObj": { "type": "structure", "members": { "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "CreateBackendAuthResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this request object.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName", "BackendEnvironmentName", "ResourceConfig" ] }, "CreateBackendAuthRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "CreateBackendAuthResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this request object.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for CreateBackendAuth.

", "required": [ "AppId", "ResourceName", "BackendEnvironmentName", "ResourceConfig" ] }, "CreateBackendAuthResourceConfig": { "type": "structure", "members": { "AuthResources": { "shape": "AuthResources", "locationName": "authResources", "documentation": "

Defines whether you want to configure only authentication or both authentication and authorization settings.

" }, "IdentityPoolConfigs": { "shape": "CreateBackendAuthIdentityPoolConfig", "locationName": "identityPoolConfigs", "documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

" }, "Service": { "shape": "Service", "locationName": "service", "documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

" }, "UserPoolConfigs": { "shape": "CreateBackendAuthUserPoolConfig", "locationName": "userPoolConfigs", "documentation": "

Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

" } }, "documentation": "

Defines the resource configuration when creating an auth resource in your Amplify project.

", "required": [ "AuthResources", "UserPoolConfigs", "Service" ] }, "CreateBackendAuthResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "CreateBackendAuthUserPoolConfig": { "type": "structure", "members": { "ForgotPassword": { "shape": "CreateBackendAuthForgotPasswordConfig", "locationName": "forgotPassword", "documentation": "

Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

" }, "Mfa": { "shape": "CreateBackendAuthMFAConfig", "locationName": "mfa", "documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

" }, "OAuth": { "shape": "CreateBackendAuthOAuthConfig", "locationName": "oAuth", "documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

" }, "PasswordPolicy": { "shape": "CreateBackendAuthPasswordPolicyConfig", "locationName": "passwordPolicy", "documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

" }, "RequiredSignUpAttributes": { "shape": "ListOfRequiredSignUpAttributesElement", "locationName": "requiredSignUpAttributes", "documentation": "

The required attributes to sign up new users in the user pool.

" }, "SignInMethod": { "shape": "SignInMethod", "locationName": "signInMethod", "documentation": "

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

" }, "UserPoolName": { "shape": "__string", "locationName": "userPoolName", "documentation": "

The Amazon Cognito user pool name.

" } }, "documentation": "

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

", "required": [ "RequiredSignUpAttributes", "SignInMethod", "UserPoolName" ] }, "CreateBackendConfigReqObj": { "type": "structure", "members": { "BackendManagerAppId": { "shape": "__string", "locationName": "backendManagerAppId", "documentation": "

The app ID for the backend manager.

" } }, "documentation": "

The request object for this operation.

" }, "CreateBackendConfigRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendManagerAppId": { "shape": "__string", "locationName": "backendManagerAppId", "documentation": "

The app ID for the backend manager.

" } }, "documentation": "

The request body for CreateBackendConfig.

", "required": [ "AppId" ] }, "CreateBackendConfigRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId" ] }, "CreateBackendConfigResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "CreateBackendReqObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "AppName": { "shape": "__string", "locationName": "appName", "documentation": "

The name of the app.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "ResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for the create backend request.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of the resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "AppId", "BackendEnvironmentName", "AppName" ] }, "CreateBackendRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "AppName": { "shape": "__string", "locationName": "appName", "documentation": "

The name of the app.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "ResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for the create backend request.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of the resource.

" } }, "documentation": "

The request body for CreateBackend.

", "required": [ "AppId", "BackendEnvironmentName", "AppName" ] }, "CreateBackendRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object sent when a backend is created.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "CreateBackendResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "CreateTokenRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" } }, "required": [ "AppId" ] }, "CreateTokenRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "ChallengeCode": { "shape": "__string", "locationName": "challengeCode", "documentation": "

One-time challenge code for authenticating into the Amplify Admin UI.

" }, "SessionId": { "shape": "__string", "locationName": "sessionId", "documentation": "

A unique ID provided when creating a new challenge token.

" }, "Ttl": { "shape": "__string", "locationName": "ttl", "documentation": "

The expiry time for the one-time generated token code.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId", "Ttl", "SessionId", "ChallengeCode" ] }, "CreateTokenResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "ChallengeCode": { "shape": "__string", "locationName": "challengeCode", "documentation": "

One-time challenge code for authenticating into the Amplify Admin UI.

" }, "SessionId": { "shape": "__string", "locationName": "sessionId", "documentation": "

A unique ID provided when creating a new challenge token.

" }, "Ttl": { "shape": "__string", "locationName": "ttl", "documentation": "

The expiry time for the one-time generated token code.

" } } }, "DeleteBackendAPIRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

Defines the resource configuration for the data model in your Amplify project.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for DeleteBackendAPI.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "DeleteBackendAPIResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "DeleteBackendAuthRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for DeleteBackendAuth.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "DeleteBackendAuthResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "DeleteBackendRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" } }, "required": [ "AppId", "BackendEnvironmentName" ] }, "DeleteBackendRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The returned object for a request to delete a backend.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "DeleteBackendResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "DeleteTokenRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "SessionId": { "shape": "__string", "location": "uri", "locationName": "sessionId", "documentation": "

The session ID.

" } }, "required": [ "SessionId", "AppId" ] }, "DeleteTokenRespObj": { "type": "structure", "members": { "IsSuccess": { "shape": "__boolean", "locationName": "isSuccess", "documentation": "

Indicates whether the request succeeded or failed.

" } }, "documentation": "

The response object for this operation.

", "required": [ "IsSuccess" ] }, "DeleteTokenResponse": { "type": "structure", "members": { "IsSuccess": { "shape": "__boolean", "locationName": "isSuccess", "documentation": "

Indicates whether the request succeeded or failed.

" } } }, "DeliveryMethod": { "type": "string", "enum": [ "EMAIL", "SMS" ] }, "EmailSettings": { "type": "structure", "members": { "EmailMessage": { "shape": "__string", "locationName": "emailMessage", "documentation": "

The body of the email.

" }, "EmailSubject": { "shape": "__string", "locationName": "emailSubject", "documentation": "

The subject of the email.

" } }, "documentation": "

The configuration for the email sent when an app user forgets their password.

" }, "GatewayTimeoutException": { "type": "structure", "members": { "Message": { "shape": "__string", "locationName": "message", "documentation": "

An error message to inform that the request failed.

" } }, "documentation": "

An error returned if there's a temporary issue with the service.

", "exception": true, "error": { "httpStatusCode": 504 } }, "GenerateBackendAPIModelsRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for GenerateBackendAPIModels.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "GenerateBackendAPIModelsResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "GetBackendAPICodegenRespObj": { "type": "structure", "members": { "Models": { "shape": "__string", "locationName": "models", "documentation": "

Stringified JSON of the datastore model.

" }, "Status": { "shape": "Status", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object for this operation.

" }, "GetBackendAPIModelsRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for GetBackendAPIModels.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "GetBackendAPIModelsResponse": { "type": "structure", "members": { "Models": { "shape": "__string", "locationName": "models", "documentation": "

Stringified JSON of the datastore model.

" }, "Status": { "shape": "Status", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "GetBackendAPIRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

Defines the resource configuration for the data model in your Amplify project.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for GetBackendAPI.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "GetBackendAPIRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this response object.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "GetBackendAPIResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this response object.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } } }, "GetBackendAuthReqObj": { "type": "structure", "members": { "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName" ] }, "GetBackendAuthRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for GetBackendAuth.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "GetBackendAuthRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "ResourceConfig": { "shape": "CreateBackendAuthResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for authorization requests to the backend of your Amplify project.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "GetBackendAuthResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "ResourceConfig": { "shape": "CreateBackendAuthResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for authorization requests to the backend of your Amplify project.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } } }, "GetBackendJobRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "JobId": { "shape": "__string", "location": "uri", "locationName": "jobId", "documentation": "

The ID for the job.

" } }, "required": [ "AppId", "BackendEnvironmentName", "JobId" ] }, "GetBackendJobResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "CreateTime": { "shape": "__string", "locationName": "createTime", "documentation": "

The time when the job was created.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" }, "UpdateTime": { "shape": "__string", "locationName": "updateTime", "documentation": "

The time when the job was last updated.

" } } }, "GetBackendReqObj": { "type": "structure", "members": { "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" } }, "documentation": "

The request object for this operation.

" }, "GetBackendRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" } }, "documentation": "

The request body for GetBackend.

", "required": [ "AppId" ] }, "GetBackendRespObj": { "type": "structure", "members": { "AmplifyMetaConfig": { "shape": "__string", "locationName": "amplifyMetaConfig", "documentation": "

A stringified version of the current configs for your Amplify project.

" }, "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "AppName": { "shape": "__string", "locationName": "appName", "documentation": "

The name of the app.

" }, "BackendEnvironmentList": { "shape": "ListOf__string", "locationName": "backendEnvironmentList", "documentation": "

A list of backend environments in an array.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request failed, this is the returned error.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId" ] }, "GetBackendResponse": { "type": "structure", "members": { "AmplifyMetaConfig": { "shape": "__string", "locationName": "amplifyMetaConfig", "documentation": "

A stringified version of the current configs for your Amplify project.

" }, "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "AppName": { "shape": "__string", "locationName": "appName", "documentation": "

The name of the app.

" }, "BackendEnvironmentList": { "shape": "ListOf__string", "locationName": "backendEnvironmentList", "documentation": "

A list of backend environments in an array.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request failed, this is the returned error.

" } } }, "GetTokenRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "SessionId": { "shape": "__string", "location": "uri", "locationName": "sessionId", "documentation": "

The session ID.

" } }, "required": [ "SessionId", "AppId" ] }, "GetTokenRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "ChallengeCode": { "shape": "__string", "locationName": "challengeCode", "documentation": "

The one-time challenge code for authenticating into the Amplify Admin UI.

" }, "SessionId": { "shape": "__string", "locationName": "sessionId", "documentation": "

A unique ID provided when creating a new challenge token.

" }, "Ttl": { "shape": "__string", "locationName": "ttl", "documentation": "

The expiry time for the one-time generated token code.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId", "Ttl", "SessionId", "ChallengeCode" ] }, "GetTokenResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "ChallengeCode": { "shape": "__string", "locationName": "challengeCode", "documentation": "

The one-time challenge code for authenticating into the Amplify Admin UI.

" }, "SessionId": { "shape": "__string", "locationName": "sessionId", "documentation": "

A unique ID provided when creating a new challenge token.

" }, "Ttl": { "shape": "__string", "locationName": "ttl", "documentation": "

The expiry time for the one-time generated token code.

" } } }, "ImportBackendAuthReqObj": { "type": "structure", "members": { "IdentityPoolId": { "shape": "__string", "locationName": "identityPoolId", "documentation": "

The ID of the Amazon Cognito identity pool.

" }, "NativeClientId": { "shape": "__string", "locationName": "nativeClientId", "documentation": "

The ID of the Amazon Cognito native client.

" }, "UserPoolId": { "shape": "__string", "locationName": "userPoolId", "documentation": "

The ID of the Amazon Cognito user pool.

" }, "WebClientId": { "shape": "__string", "locationName": "webClientId", "documentation": "

The ID of the Amazon Cognito web client.

" } }, "documentation": "

The request object for this operation.

", "required": [ "UserPoolId", "NativeClientId", "WebClientId" ] }, "ImportBackendAuthRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "IdentityPoolId": { "shape": "__string", "locationName": "identityPoolId", "documentation": "

The ID of the Amazon Cognito identity pool.

" }, "NativeClientId": { "shape": "__string", "locationName": "nativeClientId", "documentation": "

The ID of the Amazon Cognito native client.

" }, "UserPoolId": { "shape": "__string", "locationName": "userPoolId", "documentation": "

The ID of the Amazon Cognito user pool.

" }, "WebClientId": { "shape": "__string", "locationName": "webClientId", "documentation": "

The ID of the Amazon Cognito web client.

" } }, "documentation": "

The request body for ImportBackendAuth.

", "required": [ "AppId", "BackendEnvironmentName", "UserPoolId", "NativeClientId", "WebClientId" ] }, "ImportBackendAuthResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "InternalServiceException": { "type": "structure", "members": { "Message": { "shape": "__string", "locationName": "message", "documentation": "

An error message to inform that the request failed.

" } }, "documentation": "

An error returned if there's a temporary issue with the service.

" }, "LimitExceededException": { "type": "structure", "members": { "LimitType": { "shape": "__string", "locationName": "limitType", "documentation": "

The type of limit that was exceeded.

" }, "Message": { "shape": "__string", "locationName": "message", "documentation": "

An error message to inform that the request has failed.

" } }, "documentation": "

An error that is returned when a limit of a specific type has been exceeded.

" }, "ListBackendJobReqObj": { "type": "structure", "members": { "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "MaxResults": { "shape": "__integerMin1Max25", "locationName": "maxResults", "documentation": "

The maximum number of results that you want in the response.

" }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "

The token for the next set of results.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

Filters the list of response objects to include only those with the specified operation name.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

Filters the list of response objects to include only those with the specified status.

" } }, "documentation": "

The request object for this operation.

" }, "ListBackendJobRespObj": { "type": "structure", "members": { "Jobs": { "shape": "ListOfBackendJobRespObj", "locationName": "jobs", "documentation": "

An array of jobs and their properties.

" }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "

The token for the next set of results.

" } }, "documentation": "

The returned list of backend jobs.

" }, "ListBackendJobsRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "MaxResults": { "shape": "__integerMin1Max25", "locationName": "maxResults", "documentation": "

The maximum number of results that you want in the response.

" }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "

The token for the next set of results.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

Filters the list of response objects to include only those with the specified operation name.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

Filters the list of response objects to include only those with the specified status.

" } }, "documentation": "

The request body for ListBackendJobs.

", "required": [ "AppId", "BackendEnvironmentName" ] }, "ListBackendJobsResponse": { "type": "structure", "members": { "Jobs": { "shape": "ListOfBackendJobRespObj", "locationName": "jobs", "documentation": "

An array of jobs and their properties.

" }, "NextToken": { "shape": "__string", "locationName": "nextToken", "documentation": "

The token for the next set of results.

" } } }, "LoginAuthConfigReqObj": { "type": "structure", "members": { "AwsCognitoIdentityPoolId": { "shape": "__string", "locationName": "aws_cognito_identity_pool_id", "documentation": "

The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

" }, "AwsCognitoRegion": { "shape": "__string", "locationName": "aws_cognito_region", "documentation": "

The AWS Region for the Amplify Admin UI login.

" }, "AwsUserPoolsId": { "shape": "__string", "locationName": "aws_user_pools_id", "documentation": "

The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

" }, "AwsUserPoolsWebClientId": { "shape": "__string", "locationName": "aws_user_pools_web_client_id", "documentation": "

The web client ID for the Amazon Cognito user pools.

" } }, "documentation": "

The request object for this operation.

" }, "MFAMode": { "type": "string", "enum": [ "ON", "OFF", "OPTIONAL" ] }, "Mode": { "type": "string", "enum": [ "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT" ] }, "NotFoundException": { "type": "structure", "members": { "Message": { "shape": "__string", "locationName": "message", "documentation": "

An error message to inform that the request has failed.

" }, "ResourceType": { "shape": "__string", "locationName": "resourceType", "documentation": "

The type of resource that is not found.

" } }, "documentation": "

An error returned when a specific resource type is not found.

", "exception": true, "error": { "httpStatusCode": 404 } }, "OAuthGrantType": { "type": "string", "enum": [ "CODE", "IMPLICIT" ] }, "RemoveAllBackendsReqObj": { "type": "structure", "members": { "CleanAmplifyApp": { "shape": "__boolean", "locationName": "cleanAmplifyApp", "documentation": "

Cleans up the Amplify Console app if this value is set to true.

" } }, "documentation": "

The request object for this operation.

" }, "RemoveAllBackendsRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "CleanAmplifyApp": { "shape": "__boolean", "locationName": "cleanAmplifyApp", "documentation": "

Cleans up the Amplify Console app if this value is set to true.

" } }, "documentation": "

The request body for RemoveAllBackends.

", "required": [ "AppId" ] }, "RemoveAllBackendsRespObj": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } }, "documentation": "

The response object for this operation.

", "required": [ "AppId" ] }, "RemoveAllBackendsResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "RemoveBackendAuthReqObj": { "type": "structure", "members": { "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName" ] }, "RemoveBackendConfigRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" } }, "required": [ "AppId" ] }, "RemoveBackendConfigRespObj": { "type": "structure", "members": { "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" } }, "documentation": "

The response object for this operation.

" }, "RemoveBackendConfigResponse": { "type": "structure", "members": { "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" } } }, "ResolutionStrategy": { "type": "string", "enum": [ "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE" ] }, "ResourceConfig": { "type": "structure", "members": {}, "documentation": "

Defines the resource configuration for the data model in your Amplify project.

" }, "Service": { "type": "string", "enum": [ "COGNITO" ] }, "Settings": { "type": "structure", "members": { "MfaTypes": { "shape": "ListOfMfaTypesElement", "locationName": "mfaTypes", "documentation": "

The supported MFA types.

" }, "SmsMessage": { "shape": "__string", "locationName": "smsMessage", "documentation": "

The body of the SMS message.

" } }, "documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

" }, "SignInMethod": { "type": "string", "enum": [ "EMAIL", "EMAIL_AND_PHONE_NUMBER", "PHONE_NUMBER", "USERNAME" ] }, "SmsSettings": { "type": "structure", "members": { "SmsMessage": { "shape": "__string", "locationName": "smsMessage", "documentation": "

The body of the SMS message.

" } }, "documentation": "

SMS settings for authentication.

" }, "SocialProviderSettings": { "type": "structure", "members": { "Facebook": { "shape": "BackendAuthSocialProviderConfig" }, "Google": { "shape": "BackendAuthSocialProviderConfig" }, "LoginWithAmazon": { "shape": "BackendAuthSocialProviderConfig" }, "SignInWithApple": { "shape": "BackendAuthAppleProviderConfig" } }, "documentation": "

The settings for using the social identity providers for access to your Amplify app.

" }, "Status": { "type": "string", "enum": [ "LATEST", "STALE" ] }, "TooManyRequestsException": { "type": "structure", "members": { "LimitType": { "shape": "__string", "locationName": "limitType", "documentation": "

The type of limit that was exceeded.

" }, "Message": { "shape": "__string", "locationName": "message", "documentation": "

An error message to inform that the request has failed.

" } }, "documentation": "

An error that is returned when a limit of a specific type has been exceeded.

", "exception": true, "error": { "httpStatusCode": 429 } }, "UpdateBackendAPIRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "BackendAPIResourceConfig", "locationName": "resourceConfig", "documentation": "

Defines the resource configuration for the data model in your Amplify project.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for UpdateBackendAPI.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName" ] }, "UpdateBackendAPIResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "UpdateBackendAuthForgotPasswordConfig": { "type": "structure", "members": { "DeliveryMethod": { "shape": "DeliveryMethod", "locationName": "deliveryMethod", "documentation": "

Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.

" }, "EmailSettings": { "shape": "EmailSettings", "locationName": "emailSettings", "documentation": "

The configuration for the email sent when an app user forgets their password.

" }, "SmsSettings": { "shape": "SmsSettings", "locationName": "smsSettings", "documentation": "

The configuration for the SMS message sent when an Amplify app user forgets their password.

" } }, "documentation": "

Describes the forgot password policy for authenticating into the Amplify app.

" }, "UpdateBackendAuthIdentityPoolConfig": { "type": "structure", "members": { "UnauthenticatedLogin": { "shape": "__boolean", "locationName": "unauthenticatedLogin", "documentation": "

A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.

" } }, "documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

" }, "UpdateBackendAuthMFAConfig": { "type": "structure", "members": { "MFAMode": { "shape": "MFAMode", "documentation": "

The MFA mode for the backend of your Amplify project.

" }, "Settings": { "shape": "Settings", "locationName": "settings", "documentation": "

The settings of your MFA configuration for the backend of your Amplify project.

" } }, "documentation": "

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

" }, "UpdateBackendAuthOAuthConfig": { "type": "structure", "members": { "DomainPrefix": { "shape": "__string", "locationName": "domainPrefix", "documentation": "

The Amazon Cognito domain prefix used to create a hosted UI for authentication.

" }, "OAuthGrantType": { "shape": "OAuthGrantType", "locationName": "oAuthGrantType", "documentation": "

The OAuth grant type to allow app users to authenticate from your Amplify app.

" }, "OAuthScopes": { "shape": "ListOfOAuthScopesElement", "locationName": "oAuthScopes", "documentation": "

The list of OAuth-related flows that can allow users to authenticate from your Amplify app.

" }, "RedirectSignInURIs": { "shape": "ListOf__string", "locationName": "redirectSignInURIs", "documentation": "

Redirect URLs that OAuth uses when a user signs in to an Amplify app.

" }, "RedirectSignOutURIs": { "shape": "ListOf__string", "locationName": "redirectSignOutURIs", "documentation": "

Redirect URLs that OAuth uses when a user signs out of an Amplify app.

" }, "SocialProviderSettings": { "shape": "SocialProviderSettings", "locationName": "socialProviderSettings", "documentation": "

Describes third-party social federation configurations for allowing your users to sign in with OAuth.

" } }, "documentation": "

The OAuth configurations for authenticating users into your Amplify app.

" }, "UpdateBackendAuthPasswordPolicyConfig": { "type": "structure", "members": { "AdditionalConstraints": { "shape": "ListOfAdditionalConstraintsElement", "locationName": "additionalConstraints", "documentation": "

Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.

" }, "MinimumLength": { "shape": "__double", "locationName": "minimumLength", "documentation": "

Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.

" } }, "documentation": "

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

" }, "UpdateBackendAuthReqObj": { "type": "structure", "members": { "ResourceConfig": { "shape": "UpdateBackendAuthResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this request object.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request object for this operation.

", "required": [ "ResourceName", "ResourceConfig" ] }, "UpdateBackendAuthRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "ResourceConfig": { "shape": "UpdateBackendAuthResourceConfig", "locationName": "resourceConfig", "documentation": "

The resource configuration for this request object.

" }, "ResourceName": { "shape": "__string", "locationName": "resourceName", "documentation": "

The name of this resource.

" } }, "documentation": "

The request body for UpdateBackendAuth.

", "required": [ "AppId", "BackendEnvironmentName", "ResourceName", "ResourceConfig" ] }, "UpdateBackendAuthResourceConfig": { "type": "structure", "members": { "AuthResources": { "shape": "AuthResources", "locationName": "authResources", "documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

" }, "IdentityPoolConfigs": { "shape": "UpdateBackendAuthIdentityPoolConfig", "locationName": "identityPoolConfigs", "documentation": "

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

" }, "Service": { "shape": "Service", "locationName": "service", "documentation": "

Defines the service name to use when configuring an authentication resource in your Amplify project.

" }, "UserPoolConfigs": { "shape": "UpdateBackendAuthUserPoolConfig", "locationName": "userPoolConfigs", "documentation": "

Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.

" } }, "documentation": "

Defines the resource configuration when updating an authentication resource in your Amplify project.

", "required": [ "AuthResources", "UserPoolConfigs", "Service" ] }, "UpdateBackendAuthResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" } } }, "UpdateBackendAuthUserPoolConfig": { "type": "structure", "members": { "ForgotPassword": { "shape": "UpdateBackendAuthForgotPasswordConfig", "locationName": "forgotPassword", "documentation": "

Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

" }, "Mfa": { "shape": "UpdateBackendAuthMFAConfig", "locationName": "mfa", "documentation": "

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

" }, "OAuth": { "shape": "UpdateBackendAuthOAuthConfig", "locationName": "oAuth", "documentation": "

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

" }, "PasswordPolicy": { "shape": "UpdateBackendAuthPasswordPolicyConfig", "locationName": "passwordPolicy", "documentation": "

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

" } }, "documentation": "

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

" }, "UpdateBackendConfigReqObj": { "type": "structure", "members": { "LoginAuthConfig": { "shape": "LoginAuthConfigReqObj", "locationName": "loginAuthConfig", "documentation": "

Describes the Amazon Cognito configuration for Admin UI access.

" } }, "documentation": "

The request object for this operation.

" }, "UpdateBackendConfigRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "LoginAuthConfig": { "shape": "LoginAuthConfigReqObj", "locationName": "loginAuthConfig", "documentation": "

Describes the Amazon Cognito configuration for Admin UI access.

" } }, "documentation": "

The request body for UpdateBackendConfig.

", "required": [ "AppId" ] }, "UpdateBackendConfigResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendManagerAppId": { "shape": "__string", "locationName": "backendManagerAppId", "documentation": "

The app ID for the backend manager.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "LoginAuthConfig": { "shape": "LoginAuthConfigReqObj", "locationName": "loginAuthConfig", "documentation": "

Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

" } } }, "UpdateBackendJobRequest": { "type": "structure", "members": { "AppId": { "shape": "__string", "location": "uri", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "location": "uri", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "JobId": { "shape": "__string", "location": "uri", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

Filters the list of response objects to include only those with the specified operation name.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

Filters the list of response objects to include only those with the specified status.

" } }, "documentation": "

The request body for GetBackendJob.

", "required": [ "AppId", "BackendEnvironmentName", "JobId" ] }, "UpdateBackendJobResponse": { "type": "structure", "members": { "AppId": { "shape": "__string", "locationName": "appId", "documentation": "

The app ID.

" }, "BackendEnvironmentName": { "shape": "__string", "locationName": "backendEnvironmentName", "documentation": "

The name of the backend environment.

" }, "CreateTime": { "shape": "__string", "locationName": "createTime", "documentation": "

The time when the job was created.

" }, "Error": { "shape": "__string", "locationName": "error", "documentation": "

If the request fails, this error is returned.

" }, "JobId": { "shape": "__string", "locationName": "jobId", "documentation": "

The ID for the job.

" }, "Operation": { "shape": "__string", "locationName": "operation", "documentation": "

The name of the operation.

" }, "Status": { "shape": "__string", "locationName": "status", "documentation": "

The current status of the request.

" }, "UpdateTime": { "shape": "__string", "locationName": "updateTime", "documentation": "

The time when the job was last updated.

" } } }, "AdditionalConstraintsElement": { "type": "string", "enum": [ "REQUIRE_DIGIT", "REQUIRE_LOWERCASE", "REQUIRE_SYMBOL", "REQUIRE_UPPERCASE" ] }, "MfaTypesElement": { "type": "string", "enum": [ "SMS", "TOTP" ] }, "OAuthScopesElement": { "type": "string", "enum": [ "PHONE", "EMAIL", "OPENID", "PROFILE", "AWS_COGNITO_SIGNIN_USER_ADMIN" ] }, "RequiredSignUpAttributesElement": { "type": "string", "enum": [ "ADDRESS", "BIRTHDATE", "EMAIL", "FAMILY_NAME", "GENDER", "GIVEN_NAME", "LOCALE", "MIDDLE_NAME", "NAME", "NICKNAME", "PHONE_NUMBER", "PICTURE", "PREFERRED_USERNAME", "PROFILE", "UPDATED_AT", "WEBSITE", "ZONE_INFO" ] }, "__boolean": { "type": "boolean" }, "__double": { "type": "double" }, "__integer": { "type": "integer" }, "__integerMin1Max25": { "type": "integer", "min": 1, "max": 25 }, "ListOfBackendAPIAuthType": { "type": "list", "member": { "shape": "BackendAPIAuthType" } }, "ListOfBackendJobRespObj": { "type": "list", "member": { "shape": "BackendJobRespObj" } }, "ListOfAdditionalConstraintsElement": { "type": "list", "member": { "shape": "AdditionalConstraintsElement" } }, "ListOfMfaTypesElement": { "type": "list", "member": { "shape": "MfaTypesElement" } }, "ListOfOAuthScopesElement": { "type": "list", "member": { "shape": "OAuthScopesElement" } }, "ListOfRequiredSignUpAttributesElement": { "type": "list", "member": { "shape": "RequiredSignUpAttributesElement" } }, "ListOf__string": { "type": "list", "member": { "shape": "__string" } }, "__long": { "type": "long" }, "__string": { "type": "string" }, "__timestampIso8601": { "type": "timestamp", "timestampFormat": "iso8601" }, "__timestampUnix": { "type": "timestamp", "timestampFormat": "unixTimestamp" } }, "documentation": "

AWS Amplify Admin API

" }