2020/12/01 - AmplifyBackend - 24 new api methods
Changes (New Service) The Amplify Admin UI offers an accessible way to develop app backends and manage app content. We recommend that you use the Amplify Admin UI to manage the backend of your Amplify app.
Updates the AWS resources required to access the Amplify Admin UI.
See also: AWS API Documentation
Request Syntax
client.update_backend_config(
AppId='string',
LoginAuthConfig={
'AwsCognitoIdentityPoolId': 'string',
'AwsCognitoRegion': 'string',
'AwsUserPoolsId': 'string',
'AwsUserPoolsWebClientId': 'string'
}
)
string
[REQUIRED]
The app ID.
dict
Describes the Amazon Cognito configuration for Admin UI access.
AwsCognitoIdentityPoolId (string) --
Amazon Cognito identitypool id used for the Amplify Admin UI login authorization.
AwsCognitoRegion (string) --
The AWS Region for the the Amplify Admin login.
AwsUserPoolsId (string) --
The Amazon Cognito userpool id used for Amplify Admin UI login authentication.
AwsUserPoolsWebClientId (string) --
The web client ID for the Amazon Cognito userpools.
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 failed, this is the returned error.
LoginAuthConfig (dict) --
Describes the Amazon Cognito configurations for the Admin UI auth resource to login with.
AwsCognitoIdentityPoolId (string) --
Amazon Cognito identitypool id used for the Amplify Admin UI login authorization.
AwsCognitoRegion (string) --
The AWS Region for the the Amplify Admin login.
AwsUserPoolsId (string) --
The Amazon Cognito userpool id used for Amplify Admin UI login authentication.
AwsUserPoolsWebClientId (string) --
The web client ID for the Amazon Cognito userpools.
Deletes the challenge token based on the given appId and sessionId.
See also: AWS API Documentation
Request Syntax
client.delete_token(
AppId='string',
SessionId='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The session Id.
dict
Response Syntax
{
'IsSuccess': True|False
}
Response Structure
(dict) --
200 response
IsSuccess (boolean) --
Indicates whether the request succeeded or failed.
Gets the details for a backend api.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
dict
Defines the resource configuration for the data model in your Amplify project.
AdditionalAuthTypes (list) --
Addition 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 open id 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 the amplify project.
ConflictResolution (dict) --
The conflict resoultion 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 open id 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.
string
[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 failed, this is the returned error.
ResourceConfig (dict) --
The resource configuration for this response object.
AdditionalAuthTypes (list) --
Addition 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 open id 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 the amplify project.
ConflictResolution (dict) --
The conflict resoultion 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 open id 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.
Updates a specific job.
See also: AWS API Documentation
Request Syntax
client.update_backend_job(
AppId='string',
BackendEnvironmentName='string',
JobId='string',
Operation='string',
Status='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[REQUIRED]
The ID for the job.
string
Filters the list of response objects to only include those with the specified operation name.
string
Filters the list of response objects to only include those with the specified status.
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 failed, this is the returned error.
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.
Gets a backend auth details.
See also: AWS API Documentation
Request Syntax
client.get_backend_auth(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[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'
}
}
},
'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'
}
},
'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 failed, this is the returned error.
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 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) --
Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
DeliveryMethod (string) --
Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
EmailSettings (dict) --
The configuration for the email sent when an app user forgets their password.
EmailMessage (string) --
The body of the email.
EmailSubject (string) --
The subject of the email.
SmsSettings (dict) --
The configuration for the SMS message sent when an app user forgets their password.
SmsMessage (string) --
The body of the SMS message.
Mfa (dict) --
Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
MFAMode (string) --
Describes whether MFA should be [ON, OFF, 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
(string) --
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 which you use to allow app users to authenticate from your Amplify app.
OAuthScopes (list) --
List of OAuth related flows which use to allow your app users to authenticate from your Amplify app.
(string) --
RedirectSignInURIs (list) --
The redirected URI for sigining into your Amplify app.
(string) --
RedirectSignOutURIs (list) --
Redirect URLs used by OAuth when a user signs out of an Amplify app.
(string) --
SocialProviderSettings (dict) --
The settings for using the social providers for access to 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.
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 pasword used to access the backend of your Amplify project.
(string) --
MinimumLength (float) --
The minimum length of password used to access the backend of your Amplify project.
RequiredSignUpAttributes (list) --
The required attributes to sign up new users in the user pool.
(string) --
SignInMethod (string) --
Describes the sign-in methods that your Amplify app users to login using the Amazon Cognito user pool, configured as a part of your Amplify project.
UserPoolName (string) --
The Amazon Cognito user pool name.
ResourceName (string) --
The name of this resource.
Deletes an existing backend authentication resource.
See also: AWS API Documentation
Request Syntax
client.delete_backend_auth(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
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
client.create_backend(
AppId='string',
AppName='string',
BackendEnvironmentName='string',
ResourceConfig={}
,
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the app.
string
[REQUIRED]
The name of the backend environment.
dict
The resource configuration for the create backend request.
string
The name of the 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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Generates a model schema for an existing backend API resource.
See also: AWS API Documentation
Request Syntax
client.generate_backend_api_models(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Lists the jobs for the backend of an Amplify app.
See also: AWS API Documentation
Request Syntax
client.list_backend_jobs(
AppId='string',
BackendEnvironmentName='string',
JobId='string',
MaxResults=123,
NextToken='string',
Operation='string',
Status='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
The ID for the job.
integer
The maximum number of results you want in the response.
string
The token for the next set of results.
string
Filters the list of response objects to only include those with the specified operation name.
string
Filters the list of response objects to only include those with the specified status.
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 failed, this is the returned error.
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.
Removes an existing environment from your Ampify project.
See also: AWS API Documentation
Request Syntax
client.delete_backend(
AppId='string',
BackendEnvironmentName='string'
)
string
[REQUIRED]
The app ID.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Provides project level details for your Amplify UI project.
See also: AWS API Documentation
Request Syntax
client.get_backend(
AppId='string',
BackendEnvironmentName='string'
)
string
[REQUIRED]
The app ID.
string
The name of the backend environment.
dict
Response Syntax
{
'AmplifyMetaConfig': 'string',
'AppId': 'string',
'AppName': 'string',
'BackendEnvironmentList': [
'string',
],
'BackendEnvironmentName': 'string',
'Error': 'string'
}
Response Structure
(dict) --
200 response
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.
(string) --
BackendEnvironmentName (string) --
The name of the backend environment.
Error (string) --
If the request failed, this is the returned error.
Generates a model schema for existing backend API resource.
See also: AWS API Documentation
Request Syntax
client.get_backend_api_models(
AppId='string',
BackendEnvironmentName='string',
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[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.
Gets the challenge token based on the given appId and sessionId.
See also: AWS API Documentation
Request Syntax
client.get_token(
AppId='string',
SessionId='string'
)
string
[REQUIRED]
The app ID.
string
[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 Amplify Admin UI.
SessionId (string) --
A unique identifier provided when creating a new challenge token.
Ttl (string) --
The expiry time for the one time generated token code.
Generates a one time challenge code to authenticate a user into your Amplify Admin UI.
See also: AWS API Documentation
Request Syntax
client.create_token(
AppId='string'
)
string
[REQUIRED]
The app ID.
dict
Response Syntax
{
'AppId': 'string',
'ChallengeCode': 'string',
'SessionId': 'string',
'Ttl': 'string'
}
Response Structure
(dict) --
200 response
AppId (string) --
The app ID.
ChallengeCode (string) --
One time challenge code for authenticating into Amplify Admin UI.
SessionId (string) --
A unique identifier provided when creating a new challenge token.
Ttl (string) --
The expiry time for the one time generated token code.
Updates an existing backend authentication resource.
See also: AWS API Documentation
Request Syntax
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'
}
}
},
'PasswordPolicy': {
'AdditionalConstraints': [
'REQUIRE_DIGIT'|'REQUIRE_LOWERCASE'|'REQUIRE_SYMBOL'|'REQUIRE_UPPERCASE',
],
'MinimumLength': 123.0
}
}
},
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
dict
[REQUIRED]
The resource configuration for this request object.
AuthResources (string) -- [REQUIRED]
Defines the service name to use when configuring an authentication resource in your Amplify project.
IdentityPoolConfigs (dict) --
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
UnauthenticatedLogin (boolean) --
A boolean value which can be set to allow or disallow guest level authorization into your Amplify app.
Service (string) -- [REQUIRED]
Defines the service name to use when configuring an authentication resource in your Amplify project.
UserPoolConfigs (dict) -- [REQUIRED]
Describes the authentication configuration for the Amazon Cognito userpool, provisioned as a part of your auth resource in the Amplify project.
ForgotPassword (dict) --
Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
DeliveryMethod (string) --
Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
EmailSettings (dict) --
The configuration for the email sent when an app user forgets their password.
EmailMessage (string) --
The body of the email.
EmailSubject (string) --
The subject of the email.
SmsSettings (dict) --
The configuration for the SMS message sent when an Amplify app user forgets their password.
SmsMessage (string) --
The body of the SMS message.
Mfa (dict) --
Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
MFAMode (string) --
The MFA mode for the backend of your Amplify project.
Settings (dict) --
The settings of your MFA configuration for the backend of your Amplify project.
MfaTypes (list) --
The supported MFA types
(string) --
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 Amazon Cognito domain prefix used to create a hosted UI for authentication.
OAuthGrantType (string) --
The OAuth grant type to allow app users to authenticate from your Amplify app.
OAuthScopes (list) --
The list of OAuth related flows which can allow users to authenticate from your Amplify app.
(string) --
RedirectSignInURIs (list) --
Redirect URLs used by OAuth when a user signs in to an Amplify app.
(string) --
RedirectSignOutURIs (list) --
Redirect URLs used by OAuth when a user signs out of an Amplify app.
(string) --
SocialProviderSettings (dict) --
Describes third party social federation configurations for allowing your users to sign in with OAuth.
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.
PasswordPolicy (dict) --
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
AdditionalConstraints (list) --
Describes additional constrains on password requirements to sign in into the auth resource, configured as a part of your Ampify project.
(string) --
MinimumLength (float) --
Describes the minimum length of password required to sign in into the auth resource, configured as a part of your Ampify project.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Creates a new backend API resource.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
dict
[REQUIRED]
The resource configuration for this request.
AdditionalAuthTypes (list) --
Addition 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 open id 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 the amplify project.
ConflictResolution (dict) --
The conflict resoultion 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 open id 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.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Creates a config object for a backend.
See also: AWS API Documentation
Request Syntax
client.create_backend_config(
AppId='string',
BackendManagerAppId='string'
)
string
[REQUIRED]
The app ID.
string
The app ID for the backend manager.
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.
Removes all backend environments from your Amplify project.
See also: AWS API Documentation
Request Syntax
client.remove_all_backends(
AppId='string',
CleanAmplifyApp=True|False
)
string
[REQUIRED]
The app ID.
boolean
Cleans up the Amplify Console app if this value is set to true.
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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Updates an existing backend API resource.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
dict
Defines the resource configuration for the data model in your Amplify project.
AdditionalAuthTypes (list) --
Addition 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 open id 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 the amplify project.
ConflictResolution (dict) --
The conflict resoultion 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 open id 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.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Creates a new backend authentication resource.
See also: AWS API Documentation
Request Syntax
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'
}
}
},
'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'
}
},
ResourceName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
dict
[REQUIRED]
The resource configuration for this request object.
AuthResources (string) -- [REQUIRED]
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) -- [REQUIRED]
Name of the identity pool used for authorization.
UnauthenticatedLogin (boolean) -- [REQUIRED]
Set to true or false based on whether you want to enable guest authorization to your Amplify app.
Service (string) -- [REQUIRED]
Defines the service name to use when configuring an authentication resource in your Amplify project.
UserPoolConfigs (dict) -- [REQUIRED]
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
ForgotPassword (dict) --
Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
DeliveryMethod (string) -- [REQUIRED]
Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
EmailSettings (dict) --
The configuration for the email sent when an app user forgets their password.
EmailMessage (string) --
The body of the email.
EmailSubject (string) --
The subject of the email.
SmsSettings (dict) --
The configuration for the SMS message sent when an app user forgets their password.
SmsMessage (string) --
The body of the SMS message.
Mfa (dict) --
Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
MFAMode (string) -- [REQUIRED]
Describes whether MFA should be [ON, OFF, 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
(string) --
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) -- [REQUIRED]
The OAuth grant type which you use to allow app users to authenticate from your Amplify app.
OAuthScopes (list) -- [REQUIRED]
List of OAuth related flows which use to allow your app users to authenticate from your Amplify app.
(string) --
RedirectSignInURIs (list) -- [REQUIRED]
The redirected URI for sigining into your Amplify app.
(string) --
RedirectSignOutURIs (list) -- [REQUIRED]
Redirect URLs used by OAuth when a user signs out of an Amplify app.
(string) --
SocialProviderSettings (dict) --
The settings for using the social providers for access to 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.
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 pasword used to access the backend of your Amplify project.
(string) --
MinimumLength (float) -- [REQUIRED]
The minimum length of password used to access the backend of your Amplify project.
RequiredSignUpAttributes (list) -- [REQUIRED]
The required attributes to sign up new users in the user pool.
(string) --
SignInMethod (string) -- [REQUIRED]
Describes the sign-in methods that your Amplify app users to login using the Amazon Cognito user pool, configured as a part of your Amplify project.
UserPoolName (string) -- [REQUIRED]
The Amazon Cognito user pool name.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Deletes an existing backend API resource.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
dict
Defines the resource configuration for the data model in your Amplify project.
AdditionalAuthTypes (list) --
Addition 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 open id 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 the amplify project.
ConflictResolution (dict) --
The conflict resoultion 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 open id 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.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
This operation clones an existing backend.
See also: AWS API Documentation
Request Syntax
client.clone_backend(
AppId='string',
BackendEnvironmentName='string',
TargetEnvironmentName='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[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 failed, this is the returned error.
JobId (string) --
The ID for the job.
Operation (string) --
The name of the operation.
Status (string) --
The current status of the request.
Returns information about a specific job.
See also: AWS API Documentation
Request Syntax
client.get_backend_job(
AppId='string',
BackendEnvironmentName='string',
JobId='string'
)
string
[REQUIRED]
The app ID.
string
[REQUIRED]
The name of the backend environment.
string
[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 failed, this is the returned error.
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.
Removes the AWS resources required to access the Amplify Admin UI.
See also: AWS API Documentation
Request Syntax
client.remove_backend_config(
AppId='string'
)
string
[REQUIRED]
The app ID.
dict
Response Syntax
{
'Error': 'string'
}
Response Structure
(dict) --
200 response
Error (string) --
If the request failed, this is the returned error.