Table of Contents
AmplifyBackend.Client¶A low-level client representing AmplifyBackend
AWS Amplify Admin API
import boto3
client = boto3.client('amplifybackend')
These are the available methods:
can_paginate()clone_backend()close()create_backend()create_backend_api()create_backend_auth()create_backend_config()create_backend_storage()create_token()delete_backend()delete_backend_api()delete_backend_auth()delete_backend_storage()delete_token()generate_backend_api_models()get_backend()get_backend_api()get_backend_api_models()get_backend_auth()get_backend_job()get_backend_storage()get_paginator()get_token()get_waiter()import_backend_auth()import_backend_storage()list_backend_jobs()list_s3_buckets()remove_all_backends()remove_backend_config()update_backend_api()update_backend_auth()update_backend_config()update_backend_job()update_backend_storage()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.clone_backend(**kwargs)¶This operation clones an existing backend.
See also: AWS API Documentation
Request Syntax
response = client.clone_backend(
AppId='string',
BackendEnvironmentName='string',
TargetEnvironmentName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of the destination backend environment to be created.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionclose()¶Closes underlying endpoint connections.
create_backend(**kwargs)¶This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
See also: AWS API Documentation
Request Syntax
response = client.create_backend(
AppId='string',
AppName='string',
BackendEnvironmentName='string',
ResourceConfig={}
,
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the app.
[REQUIRED]
The name of the backend environment.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptioncreate_backend_api(**kwargs)¶Creates a new backend API resource.
See also: AWS API Documentation
Request Syntax
response = client.create_backend_api(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'AdditionalAuthTypes': [
{
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
],
'ApiName': 'string',
'ConflictResolution': {
'ResolutionStrategy': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE'
},
'DefaultAuthType': {
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
'Service': 'string',
'TransformSchema': 'string'
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The resource configuration for this request.
Additional authentication methods used to interact with your data models.
Describes the auth types for your configured data models.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The API name used to interact with the data model, configured as a part of your Amplify project.
The conflict resolution strategy for your data stored in the data models.
The strategy for conflict resolution.
The default authentication type for interacting with the configured data models in your Amplify project.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The service used to provision and interact with the data model.
The definition of the data model in the annotated transform of the GraphQL schema.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptioncreate_backend_auth(**kwargs)¶Creates a new backend authentication resource.
See also: AWS API Documentation
Request Syntax
response = client.create_backend_auth(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'AuthResources': 'USER_POOL_ONLY'|'IDENTITY_POOL_AND_USER_POOL',
'IdentityPoolConfigs': {
'IdentityPoolName': 'string',
'UnauthenticatedLogin': True|False
},
'Service': 'COGNITO',
'UserPoolConfigs': {
'ForgotPassword': {
'DeliveryMethod': 'EMAIL'|'SMS',
'EmailSettings': {
'EmailMessage': 'string',
'EmailSubject': 'string'
},
'SmsSettings': {
'SmsMessage': 'string'
}
},
'Mfa': {
'MFAMode': 'ON'|'OFF'|'OPTIONAL',
'Settings': {
'MfaTypes': [
'SMS'|'TOTP',
],
'SmsMessage': 'string'
}
},
'OAuth': {
'DomainPrefix': 'string',
'OAuthGrantType': 'CODE'|'IMPLICIT',
'OAuthScopes': [
'PHONE'|'EMAIL'|'OPENID'|'PROFILE'|'AWS_COGNITO_SIGNIN_USER_ADMIN',
],
'RedirectSignInURIs': [
'string',
],
'RedirectSignOutURIs': [
'string',
],
'SocialProviderSettings': {
'Facebook': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'Google': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'LoginWithAmazon': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'SignInWithApple': {
'ClientId': 'string',
'KeyId': 'string',
'PrivateKey': 'string',
'TeamId': 'string'
}
}
},
'PasswordPolicy': {
'AdditionalConstraints': [
'REQUIRE_DIGIT'|'REQUIRE_LOWERCASE'|'REQUIRE_SYMBOL'|'REQUIRE_UPPERCASE',
],
'MinimumLength': 123.0
},
'RequiredSignUpAttributes': [
'ADDRESS'|'BIRTHDATE'|'EMAIL'|'FAMILY_NAME'|'GENDER'|'GIVEN_NAME'|'LOCALE'|'MIDDLE_NAME'|'NAME'|'NICKNAME'|'PHONE_NUMBER'|'PICTURE'|'PREFERRED_USERNAME'|'PROFILE'|'UPDATED_AT'|'WEBSITE'|'ZONE_INFO',
],
'SignInMethod': 'EMAIL'|'EMAIL_AND_PHONE_NUMBER'|'PHONE_NUMBER'|'USERNAME',
'UserPoolName': 'string',
'VerificationMessage': {
'DeliveryMethod': 'EMAIL'|'SMS',
'EmailSettings': {
'EmailMessage': 'string',
'EmailSubject': 'string'
},
'SmsSettings': {
'SmsMessage': 'string'
}
}
}
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The resource configuration for this request object.
Defines whether you want to configure only authentication or both authentication and authorization settings.
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
Name of the Amazon Cognito identity pool used for authorization.
Set to true or false based on whether you want to enable guest authorization to your Amplify app.
Defines the service name to use when configuring an authentication resource in your Amplify project.
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
The contents of the email message.
The contents of the subject line of the email message.
(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
The contents of the SMS message.
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
Describes the configuration settings and methods for your Amplify app users to use MFA.
The supported MFA types.
The body of the SMS message.
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
The domain prefix for your Amplify app.
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
The redirected URI for signing in to your Amplify app.
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
The settings for using social providers to access your Amplify app.
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id, which can be obtained from the third-party social federation provider.
Describes the client_secret, which can be obtained from third-party social federation providers.
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id, which can be obtained from the third-party social federation provider.
Describes the client_secret, which can be obtained from third-party social federation providers.
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id, which can be obtained from the third-party social federation provider.
Describes the client_secret, which can be obtained from third-party social federation providers.
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id (also called Services ID) that comes from Apple.
Describes the key_id that comes from Apple.
Describes the private_key that comes from Apple.
Describes the team_id that comes from Apple.
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
Additional constraints for the password used to access the backend of your Amplify project.
The minimum length of the password used to access the backend of your Amplify project.
The required attributes to sign up new users in the user pool.
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.
The Amazon Cognito user pool name.
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
The type of verification message to send.
The settings for the email message.
The contents of the email message.
The contents of the subject line of the email message.
The settings for the SMS message.
The contents of the SMS message.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptioncreate_backend_config(**kwargs)¶Creates a config object for a backend.
See also: AWS API Documentation
Request Syntax
response = client.create_backend_config(
AppId='string',
BackendManagerAppId='string'
)
[REQUIRED]
The app ID.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'JobId': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
JobId (string) --
The ID for the job.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptioncreate_backend_storage(**kwargs)¶Creates a backend storage resource.
See also: AWS API Documentation
Request Syntax
response = client.create_backend_storage(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'BucketName': 'string',
'Permissions': {
'Authenticated': [
'READ'|'CREATE_AND_UPDATE'|'DELETE',
],
'UnAuthenticated': [
'READ'|'CREATE_AND_UPDATE'|'DELETE',
]
},
'ServiceName': 'S3'
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The resource configuration for creating backend storage.
The name of the S3 bucket.
The authorization configuration for the storage S3 bucket.
Lists all authenticated user read, write, and delete permissions for your S3 bucket.
Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
The name of the storage service.
[REQUIRED]
The name of the storage resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'JobId': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
JobId (string) --
The ID for the job.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptioncreate_token(**kwargs)¶Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
See also: AWS API Documentation
Request Syntax
response = client.create_token(
AppId='string'
)
[REQUIRED]
The app ID.
{
'AppId': 'string',
'ChallengeCode': 'string',
'SessionId': 'string',
'Ttl': 'string'
}
Response Structure
200 response
The app ID.
One-time challenge code for authenticating into the Amplify Admin UI.
A unique ID provided when creating a new challenge token.
The expiry time for the one-time generated token code.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptiondelete_backend(**kwargs)¶Removes an existing environment from your Amplify project.
See also: AWS API Documentation
Request Syntax
response = client.delete_backend(
AppId='string',
BackendEnvironmentName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptiondelete_backend_api(**kwargs)¶Deletes an existing backend API resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_backend_api(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'AdditionalAuthTypes': [
{
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
],
'ApiName': 'string',
'ConflictResolution': {
'ResolutionStrategy': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE'
},
'DefaultAuthType': {
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
'Service': 'string',
'TransformSchema': 'string'
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
Defines the resource configuration for the data model in your Amplify project.
Additional authentication methods used to interact with your data models.
Describes the auth types for your configured data models.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The API name used to interact with the data model, configured as a part of your Amplify project.
The conflict resolution strategy for your data stored in the data models.
The strategy for conflict resolution.
The default authentication type for interacting with the configured data models in your Amplify project.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The service used to provision and interact with the data model.
The definition of the data model in the annotated transform of the GraphQL schema.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptiondelete_backend_auth(**kwargs)¶Deletes an existing backend authentication resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_backend_auth(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptiondelete_backend_storage(**kwargs)¶Removes the specified backend storage resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_backend_storage(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string',
ServiceName='S3'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of the storage resource.
[REQUIRED]
The name of the storage service.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'JobId': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
JobId (string) --
The ID for the job.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptiondelete_token(**kwargs)¶Deletes the challenge token based on the given appId and sessionId.
See also: AWS API Documentation
Request Syntax
response = client.delete_token(
AppId='string',
SessionId='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The session ID.
dict
Response Syntax
{
'IsSuccess': True|False
}
Response Structure
(dict) --
200 response
IsSuccess (boolean) --
Indicates whether the request succeeded or failed.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptiongenerate_backend_api_models(**kwargs)¶Generates a model schema for an existing backend API resource.
See also: AWS API Documentation
Request Syntax
response = client.generate_backend_api_models(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_backend(**kwargs)¶Provides project-level details for your Amplify UI project.
See also: AWS API Documentation
Request Syntax
response = client.get_backend(
AppId='string',
BackendEnvironmentName='string'
)
[REQUIRED]
The app ID.
dict
Response Syntax
{
'AmplifyFeatureFlags': 'string',
'AmplifyMetaConfig': 'string',
'AppId': 'string',
'AppName': 'string',
'BackendEnvironmentList': [
'string',
],
'BackendEnvironmentName': 'string',
'Error': 'string'
}
Response Structure
(dict) --
200 response
AmplifyFeatureFlags (string) --
A stringified version of the cli.json file for your Amplify project.
AmplifyMetaConfig (string) --
A stringified version of the current configs for your Amplify project.
AppId (string) --
The app ID.
AppName (string) --
The name of the app.
BackendEnvironmentList (list) --
A list of backend environments in an array.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request failed, this is the returned error.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_backend_api(**kwargs)¶Gets the details for a backend API.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_api(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'AdditionalAuthTypes': [
{
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
],
'ApiName': 'string',
'ConflictResolution': {
'ResolutionStrategy': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE'
},
'DefaultAuthType': {
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
'Service': 'string',
'TransformSchema': 'string'
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
Defines the resource configuration for the data model in your Amplify project.
Additional authentication methods used to interact with your data models.
Describes the auth types for your configured data models.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The API name used to interact with the data model, configured as a part of your Amplify project.
The conflict resolution strategy for your data stored in the data models.
The strategy for conflict resolution.
The default authentication type for interacting with the configured data models in your Amplify project.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The service used to provision and interact with the data model.
The definition of the data model in the annotated transform of the GraphQL schema.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'ResourceConfig': {
'AdditionalAuthTypes': [
{
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
],
'ApiName': 'string',
'ConflictResolution': {
'ResolutionStrategy': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE'
},
'DefaultAuthType': {
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
'Service': 'string',
'TransformSchema': 'string'
},
'ResourceName': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
ResourceConfig (dict) --
The resource configuration for this response object.
AdditionalAuthTypes (list) --
Additional authentication methods used to interact with your data models.
(dict) --
Describes the auth types for your configured data models.
Mode (string) --
Describes the authentication mode.
Settings (dict) --
Describes settings for the authentication mode.
CognitoUserPoolId (string) --
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
Description (string) --
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
ExpirationTime (float) --
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
OpenIDAuthTTL (string) --
The expiry time for the OpenID authentication mechanism.
OpenIDClientId (string) --
The clientID for openID, if openID was used as an authentication setting to access your data models.
OpenIDIatTTL (string) --
The expiry time for the OpenID authentication mechanism.
OpenIDIssueURL (string) --
The openID issuer URL, if openID was used as an authentication setting to access your data models.
OpenIDProviderName (string) --
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
ApiName (string) --
The API name used to interact with the data model, configured as a part of your Amplify project.
ConflictResolution (dict) --
The conflict resolution strategy for your data stored in the data models.
ResolutionStrategy (string) --
The strategy for conflict resolution.
DefaultAuthType (dict) --
The default authentication type for interacting with the configured data models in your Amplify project.
Mode (string) --
Describes the authentication mode.
Settings (dict) --
Describes settings for the authentication mode.
CognitoUserPoolId (string) --
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
Description (string) --
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
ExpirationTime (float) --
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
OpenIDAuthTTL (string) --
The expiry time for the OpenID authentication mechanism.
OpenIDClientId (string) --
The clientID for openID, if openID was used as an authentication setting to access your data models.
OpenIDIatTTL (string) --
The expiry time for the OpenID authentication mechanism.
OpenIDIssueURL (string) --
The openID issuer URL, if openID was used as an authentication setting to access your data models.
OpenIDProviderName (string) --
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
Service (string) --
The service used to provision and interact with the data model.
TransformSchema (string) --
The definition of the data model in the annotated transform of the GraphQL schema.
ResourceName (string) --
The name of this resource.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_backend_api_models(**kwargs)¶Generates a model schema for existing backend API resource.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_api_models(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'Models': 'string',
'Status': 'LATEST'|'STALE'
}
Response Structure
(dict) --
200 response
Models (string) --
Stringified JSON of the datastore model.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_backend_auth(**kwargs)¶Gets a backend auth details.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_auth(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'ResourceConfig': {
'AuthResources': 'USER_POOL_ONLY'|'IDENTITY_POOL_AND_USER_POOL',
'IdentityPoolConfigs': {
'IdentityPoolName': 'string',
'UnauthenticatedLogin': True|False
},
'Service': 'COGNITO',
'UserPoolConfigs': {
'ForgotPassword': {
'DeliveryMethod': 'EMAIL'|'SMS',
'EmailSettings': {
'EmailMessage': 'string',
'EmailSubject': 'string'
},
'SmsSettings': {
'SmsMessage': 'string'
}
},
'Mfa': {
'MFAMode': 'ON'|'OFF'|'OPTIONAL',
'Settings': {
'MfaTypes': [
'SMS'|'TOTP',
],
'SmsMessage': 'string'
}
},
'OAuth': {
'DomainPrefix': 'string',
'OAuthGrantType': 'CODE'|'IMPLICIT',
'OAuthScopes': [
'PHONE'|'EMAIL'|'OPENID'|'PROFILE'|'AWS_COGNITO_SIGNIN_USER_ADMIN',
],
'RedirectSignInURIs': [
'string',
],
'RedirectSignOutURIs': [
'string',
],
'SocialProviderSettings': {
'Facebook': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'Google': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'LoginWithAmazon': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'SignInWithApple': {
'ClientId': 'string',
'KeyId': 'string',
'PrivateKey': 'string',
'TeamId': 'string'
}
}
},
'PasswordPolicy': {
'AdditionalConstraints': [
'REQUIRE_DIGIT'|'REQUIRE_LOWERCASE'|'REQUIRE_SYMBOL'|'REQUIRE_UPPERCASE',
],
'MinimumLength': 123.0
},
'RequiredSignUpAttributes': [
'ADDRESS'|'BIRTHDATE'|'EMAIL'|'FAMILY_NAME'|'GENDER'|'GIVEN_NAME'|'LOCALE'|'MIDDLE_NAME'|'NAME'|'NICKNAME'|'PHONE_NUMBER'|'PICTURE'|'PREFERRED_USERNAME'|'PROFILE'|'UPDATED_AT'|'WEBSITE'|'ZONE_INFO',
],
'SignInMethod': 'EMAIL'|'EMAIL_AND_PHONE_NUMBER'|'PHONE_NUMBER'|'USERNAME',
'UserPoolName': 'string',
'VerificationMessage': {
'DeliveryMethod': 'EMAIL'|'SMS',
'EmailSettings': {
'EmailMessage': 'string',
'EmailSubject': 'string'
},
'SmsSettings': {
'SmsMessage': 'string'
}
}
}
},
'ResourceName': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
ResourceConfig (dict) --
The resource configuration for authorization requests to the backend of your Amplify project.
AuthResources (string) --
Defines whether you want to configure only authentication or both authentication and authorization settings.
IdentityPoolConfigs (dict) --
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
IdentityPoolName (string) --
Name of the Amazon Cognito identity pool used for authorization.
UnauthenticatedLogin (boolean) --
Set to true or false based on whether you want to enable guest authorization to your Amplify app.
Service (string) --
Defines the service name to use when configuring an authentication resource in your Amplify project.
UserPoolConfigs (dict) --
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
ForgotPassword (dict) --
(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
DeliveryMethod (string) --
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
EmailSettings (dict) --
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
EmailMessage (string) --
The contents of the email message.
EmailSubject (string) --
The contents of the subject line of the email message.
SmsSettings (dict) --
(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
SmsMessage (string) --
The contents of the SMS message.
Mfa (dict) --
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
MFAMode (string) --
Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
Settings (dict) --
Describes the configuration settings and methods for your Amplify app users to use MFA.
MfaTypes (list) --
The supported MFA types.
SmsMessage (string) --
The body of the SMS message.
OAuth (dict) --
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
DomainPrefix (string) --
The domain prefix for your Amplify app.
OAuthGrantType (string) --
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
OAuthScopes (list) --
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
RedirectSignInURIs (list) --
The redirected URI for signing in to your Amplify app.
RedirectSignOutURIs (list) --
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
SocialProviderSettings (dict) --
The settings for using social providers to access your Amplify app.
Facebook (dict) --
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
ClientId (string) --
Describes the client_id, which can be obtained from the third-party social federation provider.
ClientSecret (string) --
Describes the client_secret, which can be obtained from third-party social federation providers.
Google (dict) --
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
ClientId (string) --
Describes the client_id, which can be obtained from the third-party social federation provider.
ClientSecret (string) --
Describes the client_secret, which can be obtained from third-party social federation providers.
LoginWithAmazon (dict) --
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
ClientId (string) --
Describes the client_id, which can be obtained from the third-party social federation provider.
ClientSecret (string) --
Describes the client_secret, which can be obtained from third-party social federation providers.
SignInWithApple (dict) --
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
ClientId (string) --
Describes the client_id (also called Services ID) that comes from Apple.
KeyId (string) --
Describes the key_id that comes from Apple.
PrivateKey (string) --
Describes the private_key that comes from Apple.
TeamId (string) --
Describes the team_id that comes from Apple.
PasswordPolicy (dict) --
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
AdditionalConstraints (list) --
Additional constraints for the password used to access the backend of your Amplify project.
MinimumLength (float) --
The minimum length of the password used to access the backend of your Amplify project.
RequiredSignUpAttributes (list) --
The required attributes to sign up new users in the user pool.
SignInMethod (string) --
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 (string) --
The Amazon Cognito user pool name.
VerificationMessage (dict) --
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
DeliveryMethod (string) --
The type of verification message to send.
EmailSettings (dict) --
The settings for the email message.
EmailMessage (string) --
The contents of the email message.
EmailSubject (string) --
The contents of the subject line of the email message.
SmsSettings (dict) --
The settings for the SMS message.
SmsMessage (string) --
The contents of the SMS message.
ResourceName (string) --
The name of this resource.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_backend_job(**kwargs)¶Returns information about a specific job.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_job(
AppId='string',
BackendEnvironmentName='string',
JobId='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The ID for the job.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'CreateTime': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string',
'UpdateTime': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
CreateTime (string) --
The time when the job was created.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
UpdateTime (string) --
The time when the job was last updated.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_backend_storage(**kwargs)¶Gets details for a backend storage resource.
See also: AWS API Documentation
Request Syntax
response = client.get_backend_storage(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of the storage resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'ResourceConfig': {
'BucketName': 'string',
'Imported': True|False,
'Permissions': {
'Authenticated': [
'READ'|'CREATE_AND_UPDATE'|'DELETE',
],
'UnAuthenticated': [
'READ'|'CREATE_AND_UPDATE'|'DELETE',
]
},
'ServiceName': 'S3'
},
'ResourceName': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
ResourceConfig (dict) --
The resource configuration for the backend storage resource.
BucketName (string) --
The name of the S3 bucket.
Imported (boolean) --
Returns True if the storage resource has been imported.
Permissions (dict) --
The authorization configuration for the storage S3 bucket.
Authenticated (list) --
Lists all authenticated user read, write, and delete permissions for your S3 bucket.
UnAuthenticated (list) --
Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
ServiceName (string) --
The name of the storage service.
ResourceName (string) --
The name of the storage resource.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_token(**kwargs)¶Gets the challenge token based on the given appId and sessionId.
See also: AWS API Documentation
Request Syntax
response = client.get_token(
AppId='string',
SessionId='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The session ID.
dict
Response Syntax
{
'AppId': 'string',
'ChallengeCode': 'string',
'SessionId': 'string',
'Ttl': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
ChallengeCode (string) --
The one-time challenge code for authenticating into the Amplify Admin UI.
SessionId (string) --
A unique ID provided when creating a new challenge token.
Ttl (string) --
The expiry time for the one-time generated token code.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
import_backend_auth(**kwargs)¶Imports an existing backend authentication resource.
See also: AWS API Documentation
Request Syntax
response = client.import_backend_auth(
AppId='string',
BackendEnvironmentName='string',
IdentityPoolId='string',
NativeClientId='string',
UserPoolId='string',
WebClientId='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The ID of the Amazon Cognito native client.
[REQUIRED]
The ID of the Amazon Cognito user pool.
[REQUIRED]
The ID of the Amazon Cognito web client.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionimport_backend_storage(**kwargs)¶Imports an existing backend storage resource.
See also: AWS API Documentation
Request Syntax
response = client.import_backend_storage(
AppId='string',
BackendEnvironmentName='string',
BucketName='string',
ServiceName='S3'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The name of the storage service.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'JobId': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
JobId (string) --
The ID for the job.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionlist_backend_jobs(**kwargs)¶Lists the jobs for the backend of an Amplify app.
See also: AWS API Documentation
Request Syntax
response = client.list_backend_jobs(
AppId='string',
BackendEnvironmentName='string',
JobId='string',
MaxResults=123,
NextToken='string',
Operation='string',
Status='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
dict
Response Syntax
{
'Jobs': [
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'CreateTime': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string',
'UpdateTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
200 response
Jobs (list) --
An array of jobs and their properties.
(dict) --
The response object for this operation.
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
CreateTime (string) --
The time when the job was created.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
UpdateTime (string) --
The time when the job was last updated.
NextToken (string) --
The token for the next set of results.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionlist_s3_buckets(**kwargs)¶The list of S3 buckets in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_s3_buckets(
NextToken='string'
)
{
'Buckets': [
{
'CreationDate': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
200 response
The list of S3 buckets.
Describes the metadata of the S3 bucket.
The creation date of the S3 bucket.
The name of the S3 bucket.
Reserved for future use.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionremove_all_backends(**kwargs)¶Removes all backend environments from your Amplify project.
See also: AWS API Documentation
Request Syntax
response = client.remove_all_backends(
AppId='string',
CleanAmplifyApp=True|False
)
[REQUIRED]
The app ID.
dict
Response Syntax
{
'AppId': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionremove_backend_config(**kwargs)¶Removes the AWS resources required to access the Amplify Admin UI.
See also: AWS API Documentation
Request Syntax
response = client.remove_backend_config(
AppId='string'
)
[REQUIRED]
The app ID.
{
'Error': 'string'
}
Response Structure
200 response
If the request fails, this error is returned.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionupdate_backend_api(**kwargs)¶Updates an existing backend API resource.
See also: AWS API Documentation
Request Syntax
response = client.update_backend_api(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'AdditionalAuthTypes': [
{
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
],
'ApiName': 'string',
'ConflictResolution': {
'ResolutionStrategy': 'OPTIMISTIC_CONCURRENCY'|'LAMBDA'|'AUTOMERGE'|'NONE'
},
'DefaultAuthType': {
'Mode': 'API_KEY'|'AWS_IAM'|'AMAZON_COGNITO_USER_POOLS'|'OPENID_CONNECT',
'Settings': {
'CognitoUserPoolId': 'string',
'Description': 'string',
'ExpirationTime': 123.0,
'OpenIDAuthTTL': 'string',
'OpenIDClientId': 'string',
'OpenIDIatTTL': 'string',
'OpenIDIssueURL': 'string',
'OpenIDProviderName': 'string'
}
},
'Service': 'string',
'TransformSchema': 'string'
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
Defines the resource configuration for the data model in your Amplify project.
Additional authentication methods used to interact with your data models.
Describes the auth types for your configured data models.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The API name used to interact with the data model, configured as a part of your Amplify project.
The conflict resolution strategy for your data stored in the data models.
The strategy for conflict resolution.
The default authentication type for interacting with the configured data models in your Amplify project.
Describes the authentication mode.
Describes settings for the authentication mode.
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
The expiry time for the OpenID authentication mechanism.
The clientID for openID, if openID was used as an authentication setting to access your data models.
The expiry time for the OpenID authentication mechanism.
The openID issuer URL, if openID was used as an authentication setting to access your data models.
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
The service used to provision and interact with the data model.
The definition of the data model in the annotated transform of the GraphQL schema.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionupdate_backend_auth(**kwargs)¶Updates an existing backend authentication resource.
See also: AWS API Documentation
Request Syntax
response = client.update_backend_auth(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'AuthResources': 'USER_POOL_ONLY'|'IDENTITY_POOL_AND_USER_POOL',
'IdentityPoolConfigs': {
'UnauthenticatedLogin': True|False
},
'Service': 'COGNITO',
'UserPoolConfigs': {
'ForgotPassword': {
'DeliveryMethod': 'EMAIL'|'SMS',
'EmailSettings': {
'EmailMessage': 'string',
'EmailSubject': 'string'
},
'SmsSettings': {
'SmsMessage': 'string'
}
},
'Mfa': {
'MFAMode': 'ON'|'OFF'|'OPTIONAL',
'Settings': {
'MfaTypes': [
'SMS'|'TOTP',
],
'SmsMessage': 'string'
}
},
'OAuth': {
'DomainPrefix': 'string',
'OAuthGrantType': 'CODE'|'IMPLICIT',
'OAuthScopes': [
'PHONE'|'EMAIL'|'OPENID'|'PROFILE'|'AWS_COGNITO_SIGNIN_USER_ADMIN',
],
'RedirectSignInURIs': [
'string',
],
'RedirectSignOutURIs': [
'string',
],
'SocialProviderSettings': {
'Facebook': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'Google': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'LoginWithAmazon': {
'ClientId': 'string',
'ClientSecret': 'string'
},
'SignInWithApple': {
'ClientId': 'string',
'KeyId': 'string',
'PrivateKey': 'string',
'TeamId': 'string'
}
}
},
'PasswordPolicy': {
'AdditionalConstraints': [
'REQUIRE_DIGIT'|'REQUIRE_LOWERCASE'|'REQUIRE_SYMBOL'|'REQUIRE_UPPERCASE',
],
'MinimumLength': 123.0
},
'VerificationMessage': {
'DeliveryMethod': 'EMAIL'|'SMS',
'EmailSettings': {
'EmailMessage': 'string',
'EmailSubject': 'string'
},
'SmsSettings': {
'SmsMessage': 'string'
}
}
}
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The resource configuration for this request object.
Defines the service name to use when configuring an authentication resource in your Amplify project.
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
Defines the service name to use when configuring an authentication resource in your Amplify project.
Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
The contents of the email message.
The contents of the subject line of the email message.
(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
The contents of the SMS message.
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
The MFA mode for the backend of your Amplify project.
The settings of your MFA configuration for the backend of your Amplify project.
The supported MFA types.
The body of the SMS message.
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
The OAuth grant type to allow app users to authenticate from your Amplify app.
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
Describes third-party social federation configurations for allowing your users to sign in with OAuth.
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id, which can be obtained from the third-party social federation provider.
Describes the client_secret, which can be obtained from third-party social federation providers.
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id, which can be obtained from the third-party social federation provider.
Describes the client_secret, which can be obtained from third-party social federation providers.
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id, which can be obtained from the third-party social federation provider.
Describes the client_secret, which can be obtained from third-party social federation providers.
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
Describes the client_id (also called Services ID) that comes from Apple.
Describes the key_id that comes from Apple.
Describes the private_key that comes from Apple.
Describes the team_id that comes from Apple.
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
The type of verification message to send.
The settings for the email message.
The contents of the email message.
The contents of the subject line of the email message.
The settings for the SMS message.
The contents of the SMS message.
[REQUIRED]
The name of this resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionupdate_backend_config(**kwargs)¶Updates the AWS resources required to access the Amplify Admin UI.
See also: AWS API Documentation
Request Syntax
response = client.update_backend_config(
AppId='string',
LoginAuthConfig={
'AwsCognitoIdentityPoolId': 'string',
'AwsCognitoRegion': 'string',
'AwsUserPoolsId': 'string',
'AwsUserPoolsWebClientId': 'string'
}
)
[REQUIRED]
The app ID.
Describes the Amazon Cognito configuration for Admin UI access.
The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
The AWS Region for the Amplify Admin UI login.
The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
The web client ID for the Amazon Cognito user pools.
dict
Response Syntax
{
'AppId': 'string',
'BackendManagerAppId': 'string',
'Error': 'string',
'LoginAuthConfig': {
'AwsCognitoIdentityPoolId': 'string',
'AwsCognitoRegion': 'string',
'AwsUserPoolsId': 'string',
'AwsUserPoolsWebClientId': 'string'
}
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendManagerAppId (string) --
The app ID for the backend manager.
Error (string) --
If the request fails, this error is returned.
LoginAuthConfig (dict) --
Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
AwsCognitoIdentityPoolId (string) --
The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
AwsCognitoRegion (string) --
The AWS Region for the Amplify Admin UI login.
AwsUserPoolsId (string) --
The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
AwsUserPoolsWebClientId (string) --
The web client ID for the Amazon Cognito user pools.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionupdate_backend_job(**kwargs)¶Updates a specific job.
See also: AWS API Documentation
Request Syntax
response = client.update_backend_job(
AppId='string',
BackendEnvironmentName='string',
JobId='string',
Operation='string',
Status='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The ID for the job.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'CreateTime': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string',
'UpdateTime': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
CreateTime (string) --
The time when the job was created.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
UpdateTime (string) --
The time when the job was last updated.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionupdate_backend_storage(**kwargs)¶Updates an existing backend storage resource.
See also: AWS API Documentation
Request Syntax
response = client.update_backend_storage(
AppId='string',
BackendEnvironmentName='string',
ResourceConfig={
'Permissions': {
'Authenticated': [
'READ'|'CREATE_AND_UPDATE'|'DELETE',
],
'UnAuthenticated': [
'READ'|'CREATE_AND_UPDATE'|'DELETE',
]
},
'ServiceName': 'S3'
},
ResourceName='string'
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
[REQUIRED]
The resource configuration for updating backend storage.
The authorization configuration for the storage S3 bucket.
Lists all authenticated user read, write, and delete permissions for your S3 bucket.
Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
The name of the storage service.
[REQUIRED]
The name of the storage resource.
dict
Response Syntax
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'JobId': 'string',
'Status': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
JobId (string) --
The ID for the job.
Status (string) --
The current status of the request.
Exceptions
AmplifyBackend.Client.exceptions.NotFoundExceptionAmplifyBackend.Client.exceptions.GatewayTimeoutExceptionAmplifyBackend.Client.exceptions.TooManyRequestsExceptionAmplifyBackend.Client.exceptions.BadRequestExceptionThe available paginators are:
AmplifyBackend.Paginator.ListBackendJobs¶paginator = client.get_paginator('list_backend_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from AmplifyBackend.Client.list_backend_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AppId='string',
BackendEnvironmentName='string',
JobId='string',
Operation='string',
Status='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The app ID.
[REQUIRED]
The name of the backend environment.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Jobs': [
{
'AppId': 'string',
'BackendEnvironmentName': 'string',
'CreateTime': 'string',
'Error': 'string',
'JobId': 'string',
'Operation': 'string',
'Status': 'string',
'UpdateTime': 'string'
},
],
}
Response Structure
(dict) --
200 response
Jobs (list) --
An array of jobs and their properties.
(dict) --
The response object for this operation.
AppId (string) --
The app ID.
BackendEnvironmentName (string) --
The name of the backend environment.
CreateTime (string) --
The time when the job was created.
Error (string) --
If the request fails, this error is returned.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
UpdateTime (string) --
The time when the job was last updated.