AmplifyBackend ************** Client ====== class 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 Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListBackendJobs AmplifyBackend / Paginator / ListBackendJobs ListBackendJobs *************** class 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' } ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **JobId** (*string*) -- The ID for the job. * **Operation** (*string*) -- Filters the list of response objects to include only those with the specified operation name. * **Status** (*string*) -- Filters the list of response objects to include only those with the specified status. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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. AmplifyBackend / Client / get_backend get_backend *********** AmplifyBackend.Client.get_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- The name of the backend environment. Return type: dict Returns: **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. * *(string) --* * **BackendEnvironmentName** *(string) --* The name of the backend environment. * **Error** *(string) --* If the request failed, this is the returned error. **Exceptions** * "AmplifyBackend.Client.exceptions.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_paginator get_paginator ************* AmplifyBackend.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. AmplifyBackend / Client / get_backend_api_models get_backend_api_models ********************** AmplifyBackend.Client.get_backend_api_models(**kwargs) Gets a model introspection schema for an existing backend API resource. See also: AWS API Documentation **Request Syntax** response = client.get_backend_api_models( AppId='string', BackendEnvironmentName='string', ResourceName='string' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceName** (*string*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **Response Syntax** { 'Models': 'string', 'Status': 'LATEST'|'STALE', 'ModelIntrospectionSchema': 'string' } **Response Structure** * *(dict) --* 200 response * **Models** *(string) --* Stringified JSON of the datastore model. * **Status** *(string) --* The current status of the request. * **ModelIntrospectionSchema** *(string) --* Stringified JSON of the model introspection schema for an existing backend API resource. **Exceptions** * "AmplifyBackend.Client.exceptions.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / list_s3_buckets list_s3_buckets *************** AmplifyBackend.Client.list_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' ) Parameters: **NextToken** (*string*) -- Reserved for future use. Return type: dict Returns: **Response Syntax** { 'Buckets': [ { 'CreationDate': 'string', 'Name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* 200 response * **Buckets** *(list) --* The list of S3 buckets. * *(dict) --* Describes the metadata of the S3 bucket. * **CreationDate** *(string) --* The creation date of the S3 bucket. * **Name** *(string) --* The name of the S3 bucket. * **NextToken** *(string) --* Reserved for future use. **Exceptions** * "AmplifyBackend.Client.exceptions.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / import_backend_auth import_backend_auth ******************* AmplifyBackend.Client.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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **IdentityPoolId** (*string*) -- The ID of the Amazon Cognito identity pool. * **NativeClientId** (*string*) -- **[REQUIRED]** The ID of the Amazon Cognito native client. * **UserPoolId** (*string*) -- **[REQUIRED]** The ID of the Amazon Cognito user pool. * **WebClientId** (*string*) -- **[REQUIRED]** The ID of the Amazon Cognito web client. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_backend_storage get_backend_storage ******************* AmplifyBackend.Client.get_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceName** (*string*) -- **[REQUIRED]** The name of the storage resource. Return type: dict Returns: **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. * *(string) --* * **UnAuthenticated** *(list) --* Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. * *(string) --* * **ServiceName** *(string) --* The name of the storage service. * **ResourceName** *(string) --* The name of the storage resource. **Exceptions** * "AmplifyBackend.Client.exceptions.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / update_backend_auth update_backend_auth ******************* AmplifyBackend.Client.update_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*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 that 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 user pool, provisioned as a part of your auth resource in the Amplify project. * **ForgotPassword** *(dict) --* **(DEPRECATED)** Describes the forgot 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 that 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 Amplify 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) --* 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 that can allow users to authenticate from your Amplify app. * *(string) --* * **RedirectSignInURIs** *(list) --* Redirect URLs that OAuth uses when a user signs in to an Amplify app. * *(string) --* * **RedirectSignOutURIs** *(list) --* Redirect URLs that OAuth uses 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. * **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) --* Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project. * *(string) --* * **MinimumLength** *(float) --* Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project. * **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) --* **[REQUIRED]** 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*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / can_paginate can_paginate ************ AmplifyBackend.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. AmplifyBackend / Client / update_backend_storage update_backend_storage ********************** AmplifyBackend.Client.update_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- **[REQUIRED]** The resource configuration for updating backend storage. * **Permissions** *(dict) --* **[REQUIRED]** The authorization configuration for the storage S3 bucket. * **Authenticated** *(list) --* **[REQUIRED]** Lists all authenticated user read, write, and delete permissions for your S3 bucket. * *(string) --* * **UnAuthenticated** *(list) --* Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. * *(string) --* * **ServiceName** *(string) --* **[REQUIRED]** The name of the storage service. * **ResourceName** (*string*) -- **[REQUIRED]** The name of the storage resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / remove_all_backends remove_all_backends ******************* AmplifyBackend.Client.remove_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 ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **CleanAmplifyApp** (*boolean*) -- Cleans up the Amplify Console app if this value is set to true. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / generate_backend_api_models generate_backend_api_models *************************** AmplifyBackend.Client.generate_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceName** (*string*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / import_backend_storage import_backend_storage ********************** AmplifyBackend.Client.import_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **BucketName** (*string*) -- The name of the S3 bucket. * **ServiceName** (*string*) -- **[REQUIRED]** The name of the storage service. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / delete_token delete_token ************ AmplifyBackend.Client.delete_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **SessionId** (*string*) -- **[REQUIRED]** The session ID. Return type: dict Returns: **Response Syntax** { 'IsSuccess': True|False } **Response Structure** * *(dict) --* 200 response * **IsSuccess** *(boolean) --* Indicates whether the request succeeded or failed. **Exceptions** * "AmplifyBackend.Client.exceptions.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_backend_auth get_backend_auth **************** AmplifyBackend.Client.get_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceName** (*string*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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. * *(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 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. * *(string) --* * **RedirectSignInURIs** *(list) --* The redirected URI for signing in to your Amplify app. * *(string) --* * **RedirectSignOutURIs** *(list) --* Redirect URLs that OAuth uses when a user signs out of an Amplify app. * *(string) --* * **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. * *(string) --* * **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. * *(string) --* * **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / delete_backend_storage delete_backend_storage ********************** AmplifyBackend.Client.delete_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceName** (*string*) -- **[REQUIRED]** The name of the storage resource. * **ServiceName** (*string*) -- **[REQUIRED]** The name of the storage service. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / create_backend_auth create_backend_auth ******************* AmplifyBackend.Client.create_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*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 Amazon Cognito 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) --* **(DEPRECATED)** Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project. * **DeliveryMethod** *(string) --* **[REQUIRED]** **(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) --* **[REQUIRED]** 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. * *(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 that you use to allow app users to authenticate from your Amplify app. * **OAuthScopes** *(list) --* **[REQUIRED]** List of OAuth-related flows used to allow your app users to authenticate from your Amplify app. * *(string) --* * **RedirectSignInURIs** *(list) --* **[REQUIRED]** The redirected URI for signing in to your Amplify app. * *(string) --* * **RedirectSignOutURIs** *(list) --* **[REQUIRED]** Redirect URLs that OAuth uses when a user signs out of an Amplify app. * *(string) --* * **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. * *(string) --* * **MinimumLength** *(float) --* **[REQUIRED]** The minimum length of the 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 use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project. * **UserPoolName** *(string) --* **[REQUIRED]** 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) --* **[REQUIRED]** 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*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_waiter get_waiter ********** AmplifyBackend.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" AmplifyBackend / Client / create_backend_storage create_backend_storage ********************** AmplifyBackend.Client.create_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- **[REQUIRED]** The resource configuration for creating backend storage. * **BucketName** *(string) --* The name of the S3 bucket. * **Permissions** *(dict) --* **[REQUIRED]** The authorization configuration for the storage S3 bucket. * **Authenticated** *(list) --* **[REQUIRED]** Lists all authenticated user read, write, and delete permissions for your S3 bucket. * *(string) --* * **UnAuthenticated** *(list) --* Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. * *(string) --* * **ServiceName** *(string) --* **[REQUIRED]** The name of the storage service. * **ResourceName** (*string*) -- **[REQUIRED]** The name of the storage resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / create_backend_config create_backend_config ********************* AmplifyBackend.Client.create_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendManagerAppId** (*string*) -- The app ID for the backend manager. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / delete_backend_auth delete_backend_auth ******************* AmplifyBackend.Client.delete_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceName** (*string*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_token get_token ********* AmplifyBackend.Client.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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **SessionId** (*string*) -- **[REQUIRED]** The session ID. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / create_token create_token ************ AmplifyBackend.Client.create_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' ) Parameters: **AppId** (*string*) -- **[REQUIRED]** The app ID. Return type: dict Returns: **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 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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / remove_backend_config remove_backend_config ********************* AmplifyBackend.Client.remove_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' ) Parameters: **AppId** (*string*) -- **[REQUIRED]** The app ID. Return type: dict Returns: **Response Syntax** { 'Error': 'string' } **Response Structure** * *(dict) --* 200 response * **Error** *(string) --* If the request fails, this error is returned. **Exceptions** * "AmplifyBackend.Client.exceptions.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / list_backend_jobs list_backend_jobs ***************** AmplifyBackend.Client.list_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **JobId** (*string*) -- The ID for the job. * **MaxResults** (*integer*) -- The maximum number of results that you want in the response. * **NextToken** (*string*) -- The token for the next set of results. * **Operation** (*string*) -- Filters the list of response objects to include only those with the specified operation name. * **Status** (*string*) -- Filters the list of response objects to include only those with the specified status. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / update_backend_api update_backend_api ****************** AmplifyBackend.Client.update_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- Defines the resource configuration for the data model in your Amplify project. * **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*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / close close ***** AmplifyBackend.Client.close() Closes underlying endpoint connections. AmplifyBackend / Client / update_backend_job update_backend_job ****************** AmplifyBackend.Client.update_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **JobId** (*string*) -- **[REQUIRED]** The ID for the job. * **Operation** (*string*) -- Filters the list of response objects to include only those with the specified operation name. * **Status** (*string*) -- Filters the list of response objects to include only those with the specified status. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / create_backend create_backend ************** AmplifyBackend.Client.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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **AppName** (*string*) -- **[REQUIRED]** The name of the app. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- The resource configuration for creating a backend. * **ResourceName** (*string*) -- The name of the resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / create_backend_api create_backend_api ****************** AmplifyBackend.Client.create_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- **[REQUIRED]** The resource configuration for this request. * **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*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / delete_backend delete_backend ************** AmplifyBackend.Client.delete_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / clone_backend clone_backend ************* AmplifyBackend.Client.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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **TargetEnvironmentName** (*string*) -- **[REQUIRED]** The name of the destination backend environment to be created. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / delete_backend_api delete_backend_api ****************** AmplifyBackend.Client.delete_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- Defines the resource configuration for the data model in your Amplify project. * **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*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_backend_job get_backend_job *************** AmplifyBackend.Client.get_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **JobId** (*string*) -- **[REQUIRED]** The ID for the job. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / update_backend_config update_backend_config ********************* AmplifyBackend.Client.update_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' } ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **LoginAuthConfig** (*dict*) -- Describes the Amazon Cognito configuration for Admin UI access. * **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. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException" AmplifyBackend / Client / get_backend_api get_backend_api *************** AmplifyBackend.Client.get_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' ) Parameters: * **AppId** (*string*) -- **[REQUIRED]** The app ID. * **BackendEnvironmentName** (*string*) -- **[REQUIRED]** The name of the backend environment. * **ResourceConfig** (*dict*) -- Defines the resource configuration for the data model in your Amplify project. * **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*) -- **[REQUIRED]** The name of this resource. Return type: dict Returns: **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.NotFoundException" * "AmplifyBackend.Client.exceptions.GatewayTimeoutException" * "AmplifyBackend.Client.exceptions.TooManyRequestsException" * "AmplifyBackend.Client.exceptions.BadRequestException"