AmplifyBackendClient#
Index > AmplifyBackend > AmplifyBackendClient
Auto-generated documentation for AmplifyBackend type annotations stubs module types-boto3-amplifybackend.
AmplifyBackendClient#
Type annotations and code completion for boto3.client("amplifybackend").
 boto3 documentation
# AmplifyBackendClient usage example
from boto3.session import Session
from types_boto3_amplifybackend.client import AmplifyBackendClient
def get_amplifybackend_client() -> AmplifyBackendClient:
    return Session().client("amplifybackend")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("amplifybackend").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("amplifybackend")
try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.GatewayTimeoutException,
    client.exceptions.NotFoundException,
    client.exceptions.TooManyRequestsException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from types_boto3_amplifybackend.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("amplifybackend").can_paginate method.
 boto3 documentation
# can_paginate method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("amplifybackend").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...clone_backend#
This operation clones an existing backend.
Type annotations and code completion for boto3.client("amplifybackend").clone_backend method.
 boto3 documentation
# clone_backend method definition
def clone_backend(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    TargetEnvironmentName: str,
) -> CloneBackendResponseTypeDef:  # (1)
    ...# clone_backend method usage example with argument unpacking
kwargs: CloneBackendRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "TargetEnvironmentName": ...,
}
parent.clone_backend(**kwargs)create_backend#
This operation creates a backend for an Amplify app.
Type annotations and code completion for boto3.client("amplifybackend").create_backend method.
 boto3 documentation
# create_backend method definition
def create_backend(
    self,
    *,
    AppId: str,
    AppName: str,
    BackendEnvironmentName: str,
    ResourceConfig: Mapping[str, Any] = ...,
    ResourceName: str = ...,
) -> CreateBackendResponseTypeDef:  # (1)
    ...# create_backend method usage example with argument unpacking
kwargs: CreateBackendRequestTypeDef = {  # (1)
    "AppId": ...,
    "AppName": ...,
    "BackendEnvironmentName": ...,
}
parent.create_backend(**kwargs)create_backend_api#
Creates a new backend API resource.
Type annotations and code completion for boto3.client("amplifybackend").create_backend_api method.
 boto3 documentation
# create_backend_api method definition
def create_backend_api(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: BackendAPIResourceConfigUnionTypeDef,  # (1)
    ResourceName: str,
) -> CreateBackendAPIResponseTypeDef:  # (2)
    ...# create_backend_api method usage example with argument unpacking
kwargs: CreateBackendAPIRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}
parent.create_backend_api(**kwargs)create_backend_auth#
Creates a new backend authentication resource.
Type annotations and code completion for boto3.client("amplifybackend").create_backend_auth method.
 boto3 documentation
# create_backend_auth method definition
def create_backend_auth(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: CreateBackendAuthResourceConfigUnionTypeDef,  # (1)
    ResourceName: str,
) -> CreateBackendAuthResponseTypeDef:  # (2)
    ...# create_backend_auth method usage example with argument unpacking
kwargs: CreateBackendAuthRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}
parent.create_backend_auth(**kwargs)create_backend_config#
Creates a config object for a backend.
Type annotations and code completion for boto3.client("amplifybackend").create_backend_config method.
 boto3 documentation
# create_backend_config method definition
def create_backend_config(
    self,
    *,
    AppId: str,
    BackendManagerAppId: str = ...,
) -> CreateBackendConfigResponseTypeDef:  # (1)
    ...# create_backend_config method usage example with argument unpacking
kwargs: CreateBackendConfigRequestTypeDef = {  # (1)
    "AppId": ...,
}
parent.create_backend_config(**kwargs)create_backend_storage#
Creates a backend storage resource.
Type annotations and code completion for boto3.client("amplifybackend").create_backend_storage method.
 boto3 documentation
# create_backend_storage method definition
def create_backend_storage(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: CreateBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
) -> CreateBackendStorageResponseTypeDef:  # (2)
    ...# create_backend_storage method usage example with argument unpacking
kwargs: CreateBackendStorageRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}
parent.create_backend_storage(**kwargs)create_token#
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
Type annotations and code completion for boto3.client("amplifybackend").create_token method.
 boto3 documentation
# create_token method definition
def create_token(
    self,
    *,
    AppId: str,
) -> CreateTokenResponseTypeDef:  # (1)
    ...# create_token method usage example with argument unpacking
kwargs: CreateTokenRequestTypeDef = {  # (1)
    "AppId": ...,
}
parent.create_token(**kwargs)delete_backend#
Removes an existing environment from your Amplify project.
Type annotations and code completion for boto3.client("amplifybackend").delete_backend method.
 boto3 documentation
# delete_backend method definition
def delete_backend(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
) -> DeleteBackendResponseTypeDef:  # (1)
    ...# delete_backend method usage example with argument unpacking
kwargs: DeleteBackendRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
}
parent.delete_backend(**kwargs)delete_backend_api#
Deletes an existing backend API resource.
Type annotations and code completion for boto3.client("amplifybackend").delete_backend_api method.
 boto3 documentation
# delete_backend_api method definition
def delete_backend_api(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: BackendAPIResourceConfigUnionTypeDef = ...,  # (1)
) -> DeleteBackendAPIResponseTypeDef:  # (2)
    ...# delete_backend_api method usage example with argument unpacking
kwargs: DeleteBackendAPIRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.delete_backend_api(**kwargs)delete_backend_auth#
Deletes an existing backend authentication resource.
Type annotations and code completion for boto3.client("amplifybackend").delete_backend_auth method.
 boto3 documentation
# delete_backend_auth method definition
def delete_backend_auth(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
) -> DeleteBackendAuthResponseTypeDef:  # (1)
    ...# delete_backend_auth method usage example with argument unpacking
kwargs: DeleteBackendAuthRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.delete_backend_auth(**kwargs)delete_backend_storage#
Removes the specified backend storage resource.
Type annotations and code completion for boto3.client("amplifybackend").delete_backend_storage method.
 boto3 documentation
# delete_backend_storage method definition
def delete_backend_storage(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ServiceName: ServiceNameType,  # (1)
) -> DeleteBackendStorageResponseTypeDef:  # (2)
    ...# delete_backend_storage method usage example with argument unpacking
kwargs: DeleteBackendStorageRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
    "ServiceName": ...,
}
parent.delete_backend_storage(**kwargs)delete_token#
Deletes the challenge token based on the given appId and sessionId.
Type annotations and code completion for boto3.client("amplifybackend").delete_token method.
 boto3 documentation
# delete_token method definition
def delete_token(
    self,
    *,
    AppId: str,
    SessionId: str,
) -> DeleteTokenResponseTypeDef:  # (1)
    ...# delete_token method usage example with argument unpacking
kwargs: DeleteTokenRequestTypeDef = {  # (1)
    "AppId": ...,
    "SessionId": ...,
}
parent.delete_token(**kwargs)generate_backend_api_models#
Generates a model schema for an existing backend API resource.
Type annotations and code completion for boto3.client("amplifybackend").generate_backend_api_models method.
 boto3 documentation
# generate_backend_api_models method definition
def generate_backend_api_models(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
) -> GenerateBackendAPIModelsResponseTypeDef:  # (1)
    ...# generate_backend_api_models method usage example with argument unpacking
kwargs: GenerateBackendAPIModelsRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.generate_backend_api_models(**kwargs)get_backend#
Provides project-level details for your Amplify UI project.
Type annotations and code completion for boto3.client("amplifybackend").get_backend method.
 boto3 documentation
# get_backend method definition
def get_backend(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str = ...,
) -> GetBackendResponseTypeDef:  # (1)
    ...# get_backend method usage example with argument unpacking
kwargs: GetBackendRequestTypeDef = {  # (1)
    "AppId": ...,
}
parent.get_backend(**kwargs)get_backend_api#
Gets the details for a backend API.
Type annotations and code completion for boto3.client("amplifybackend").get_backend_api method.
 boto3 documentation
# get_backend_api method definition
def get_backend_api(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: BackendAPIResourceConfigUnionTypeDef = ...,  # (1)
) -> GetBackendAPIResponseTypeDef:  # (2)
    ...# get_backend_api method usage example with argument unpacking
kwargs: GetBackendAPIRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.get_backend_api(**kwargs)get_backend_api_models#
Gets a model introspection schema for an existing backend API resource.
Type annotations and code completion for boto3.client("amplifybackend").get_backend_api_models method.
 boto3 documentation
# get_backend_api_models method definition
def get_backend_api_models(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
) -> GetBackendAPIModelsResponseTypeDef:  # (1)
    ...# get_backend_api_models method usage example with argument unpacking
kwargs: GetBackendAPIModelsRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.get_backend_api_models(**kwargs)get_backend_auth#
Gets a backend auth details.
Type annotations and code completion for boto3.client("amplifybackend").get_backend_auth method.
 boto3 documentation
# get_backend_auth method definition
def get_backend_auth(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
) -> GetBackendAuthResponseTypeDef:  # (1)
    ...# get_backend_auth method usage example with argument unpacking
kwargs: GetBackendAuthRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.get_backend_auth(**kwargs)get_backend_job#
Returns information about a specific job.
Type annotations and code completion for boto3.client("amplifybackend").get_backend_job method.
 boto3 documentation
# get_backend_job method definition
def get_backend_job(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
) -> GetBackendJobResponseTypeDef:  # (1)
    ...# get_backend_job method usage example with argument unpacking
kwargs: GetBackendJobRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "JobId": ...,
}
parent.get_backend_job(**kwargs)get_backend_storage#
Gets details for a backend storage resource.
Type annotations and code completion for boto3.client("amplifybackend").get_backend_storage method.
 boto3 documentation
# get_backend_storage method definition
def get_backend_storage(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
) -> GetBackendStorageResponseTypeDef:  # (1)
    ...# get_backend_storage method usage example with argument unpacking
kwargs: GetBackendStorageRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.get_backend_storage(**kwargs)get_token#
Gets the challenge token based on the given appId and sessionId.
Type annotations and code completion for boto3.client("amplifybackend").get_token method.
 boto3 documentation
# get_token method definition
def get_token(
    self,
    *,
    AppId: str,
    SessionId: str,
) -> GetTokenResponseTypeDef:  # (1)
    ...# get_token method usage example with argument unpacking
kwargs: GetTokenRequestTypeDef = {  # (1)
    "AppId": ...,
    "SessionId": ...,
}
parent.get_token(**kwargs)import_backend_auth#
Imports an existing backend authentication resource.
Type annotations and code completion for boto3.client("amplifybackend").import_backend_auth method.
 boto3 documentation
# import_backend_auth method definition
def import_backend_auth(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    NativeClientId: str,
    UserPoolId: str,
    WebClientId: str,
    IdentityPoolId: str = ...,
) -> ImportBackendAuthResponseTypeDef:  # (1)
    ...# import_backend_auth method usage example with argument unpacking
kwargs: ImportBackendAuthRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "NativeClientId": ...,
    "UserPoolId": ...,
    "WebClientId": ...,
}
parent.import_backend_auth(**kwargs)import_backend_storage#
Imports an existing backend storage resource.
Type annotations and code completion for boto3.client("amplifybackend").import_backend_storage method.
 boto3 documentation
# import_backend_storage method definition
def import_backend_storage(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ServiceName: ServiceNameType,  # (1)
    BucketName: str = ...,
) -> ImportBackendStorageResponseTypeDef:  # (2)
    ...# import_backend_storage method usage example with argument unpacking
kwargs: ImportBackendStorageRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ServiceName": ...,
}
parent.import_backend_storage(**kwargs)list_backend_jobs#
Lists the jobs for the backend of an Amplify app.
Type annotations and code completion for boto3.client("amplifybackend").list_backend_jobs method.
 boto3 documentation
# list_backend_jobs method definition
def list_backend_jobs(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    Operation: str = ...,
    Status: str = ...,
) -> ListBackendJobsResponseTypeDef:  # (1)
    ...# list_backend_jobs method usage example with argument unpacking
kwargs: ListBackendJobsRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
}
parent.list_backend_jobs(**kwargs)list_s3_buckets#
The list of S3 buckets in your account.
Type annotations and code completion for boto3.client("amplifybackend").list_s3_buckets method.
 boto3 documentation
# list_s3_buckets method definition
def list_s3_buckets(
    self,
    *,
    NextToken: str = ...,
) -> ListS3BucketsResponseTypeDef:  # (1)
    ...# list_s3_buckets method usage example with argument unpacking
kwargs: ListS3BucketsRequestTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_s3_buckets(**kwargs)remove_all_backends#
Removes all backend environments from your Amplify project.
Type annotations and code completion for boto3.client("amplifybackend").remove_all_backends method.
 boto3 documentation
# remove_all_backends method definition
def remove_all_backends(
    self,
    *,
    AppId: str,
    CleanAmplifyApp: bool = ...,
) -> RemoveAllBackendsResponseTypeDef:  # (1)
    ...# remove_all_backends method usage example with argument unpacking
kwargs: RemoveAllBackendsRequestTypeDef = {  # (1)
    "AppId": ...,
}
parent.remove_all_backends(**kwargs)remove_backend_config#
Removes the AWS resources required to access the Amplify Admin UI.
Type annotations and code completion for boto3.client("amplifybackend").remove_backend_config method.
 boto3 documentation
# remove_backend_config method definition
def remove_backend_config(
    self,
    *,
    AppId: str,
) -> RemoveBackendConfigResponseTypeDef:  # (1)
    ...# remove_backend_config method usage example with argument unpacking
kwargs: RemoveBackendConfigRequestTypeDef = {  # (1)
    "AppId": ...,
}
parent.remove_backend_config(**kwargs)update_backend_api#
Updates an existing backend API resource.
Type annotations and code completion for boto3.client("amplifybackend").update_backend_api method.
 boto3 documentation
# update_backend_api method definition
def update_backend_api(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceName: str,
    ResourceConfig: BackendAPIResourceConfigUnionTypeDef = ...,  # (1)
) -> UpdateBackendAPIResponseTypeDef:  # (2)
    ...# update_backend_api method usage example with argument unpacking
kwargs: UpdateBackendAPIRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}
parent.update_backend_api(**kwargs)update_backend_auth#
Updates an existing backend authentication resource.
Type annotations and code completion for boto3.client("amplifybackend").update_backend_auth method.
 boto3 documentation
# update_backend_auth method definition
def update_backend_auth(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: UpdateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
) -> UpdateBackendAuthResponseTypeDef:  # (2)
    ...# update_backend_auth method usage example with argument unpacking
kwargs: UpdateBackendAuthRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}
parent.update_backend_auth(**kwargs)update_backend_config#
Updates the AWS resources required to access the Amplify Admin UI.
Type annotations and code completion for boto3.client("amplifybackend").update_backend_config method.
 boto3 documentation
# update_backend_config method definition
def update_backend_config(
    self,
    *,
    AppId: str,
    LoginAuthConfig: LoginAuthConfigReqObjTypeDef = ...,  # (1)
) -> UpdateBackendConfigResponseTypeDef:  # (2)
    ...# update_backend_config method usage example with argument unpacking
kwargs: UpdateBackendConfigRequestTypeDef = {  # (1)
    "AppId": ...,
}
parent.update_backend_config(**kwargs)update_backend_job#
Updates a specific job.
Type annotations and code completion for boto3.client("amplifybackend").update_backend_job method.
 boto3 documentation
# update_backend_job method definition
def update_backend_job(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    JobId: str,
    Operation: str = ...,
    Status: str = ...,
) -> UpdateBackendJobResponseTypeDef:  # (1)
    ...# update_backend_job method usage example with argument unpacking
kwargs: UpdateBackendJobRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "JobId": ...,
}
parent.update_backend_job(**kwargs)update_backend_storage#
Updates an existing backend storage resource.
Type annotations and code completion for boto3.client("amplifybackend").update_backend_storage method.
 boto3 documentation
# update_backend_storage method definition
def update_backend_storage(
    self,
    *,
    AppId: str,
    BackendEnvironmentName: str,
    ResourceConfig: UpdateBackendStorageResourceConfigTypeDef,  # (1)
    ResourceName: str,
) -> UpdateBackendStorageResponseTypeDef:  # (2)
    ...# update_backend_storage method usage example with argument unpacking
kwargs: UpdateBackendStorageRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}
parent.update_backend_storage(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("amplifybackend").get_paginator method with overloads.
- client.get_paginator("list_backend_jobs")-> ListBackendJobsPaginator