Skip to content

AmplifyBackendClient#

Index > AmplifyBackend > AmplifyBackendClient

Auto-generated documentation for AmplifyBackend type annotations stubs module mypy-boto3-amplifybackend.

AmplifyBackendClient#

Type annotations and code completion for boto3.client("amplifybackend"). boto3 documentation

# AmplifyBackendClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_amplifybackend.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

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:
    ...

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)
    ...
  1. See CloneBackendResponseTypeDef
# clone_backend method usage example with argument unpacking

kwargs: CloneBackendRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "TargetEnvironmentName": ...,
}

parent.clone_backend(**kwargs)
  1. See CloneBackendRequestRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("amplifybackend").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

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)
    ...
  1. See CreateBackendResponseTypeDef
# create_backend method usage example with argument unpacking

kwargs: CreateBackendRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "AppName": ...,
    "BackendEnvironmentName": ...,
}

parent.create_backend(**kwargs)
  1. See CreateBackendRequestRequestTypeDef

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: BackendAPIResourceConfigTypeDef,  # (1)
    ResourceName: str,
) -> CreateBackendAPIResponseTypeDef:  # (2)
    ...
  1. See BackendAPIResourceConfigTypeDef
  2. See CreateBackendAPIResponseTypeDef
# create_backend_api method usage example with argument unpacking

kwargs: CreateBackendAPIRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}

parent.create_backend_api(**kwargs)
  1. See CreateBackendAPIRequestRequestTypeDef

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: CreateBackendAuthResourceConfigTypeDef,  # (1)
    ResourceName: str,
) -> CreateBackendAuthResponseTypeDef:  # (2)
    ...
  1. See CreateBackendAuthResourceConfigTypeDef
  2. See CreateBackendAuthResponseTypeDef
# create_backend_auth method usage example with argument unpacking

kwargs: CreateBackendAuthRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}

parent.create_backend_auth(**kwargs)
  1. See CreateBackendAuthRequestRequestTypeDef

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)
    ...
  1. See CreateBackendConfigResponseTypeDef
# create_backend_config method usage example with argument unpacking

kwargs: CreateBackendConfigRequestRequestTypeDef = {  # (1)
    "AppId": ...,
}

parent.create_backend_config(**kwargs)
  1. See CreateBackendConfigRequestRequestTypeDef

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)
    ...
  1. See CreateBackendStorageResourceConfigTypeDef
  2. See CreateBackendStorageResponseTypeDef
# create_backend_storage method usage example with argument unpacking

kwargs: CreateBackendStorageRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceConfig": ...,
    "ResourceName": ...,
}

parent.create_backend_storage(**kwargs)
  1. See CreateBackendStorageRequestRequestTypeDef

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)
    ...
  1. See CreateTokenResponseTypeDef
# create_token method usage example with argument unpacking

kwargs: CreateTokenRequestRequestTypeDef = {  # (1)
    "AppId": ...,
}

parent.create_token(**kwargs)
  1. See CreateTokenRequestRequestTypeDef

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)
    ...
  1. See DeleteBackendResponseTypeDef
# delete_backend method usage example with argument unpacking

kwargs: DeleteBackendRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
}

parent.delete_backend(**kwargs)
  1. See DeleteBackendRequestRequestTypeDef

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: BackendAPIResourceConfigTypeDef = ...,  # (1)
) -> DeleteBackendAPIResponseTypeDef:  # (2)
    ...
  1. See BackendAPIResourceConfigTypeDef
  2. See DeleteBackendAPIResponseTypeDef
# delete_backend_api method usage example with argument unpacking

kwargs: DeleteBackendAPIRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}

parent.delete_backend_api(**kwargs)
  1. See DeleteBackendAPIRequestRequestTypeDef

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)
    ...
  1. See DeleteBackendAuthResponseTypeDef
# delete_backend_auth method usage example with argument unpacking

kwargs: DeleteBackendAuthRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
}

parent.delete_backend_auth(**kwargs)
  1. See DeleteBackendAuthRequestRequestTypeDef

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)
    ...
  1. See ServiceNameType
  2. See DeleteBackendStorageResponseTypeDef
# delete_backend_storage method usage example with argument unpacking

kwargs: DeleteBackendStorageRequestRequestTypeDef = {  # (1)
    "AppId": ...,
    "BackendEnvironmentName": ...,
    "ResourceName": ...,
    "ServiceName": ...,
}

parent.delete_backend_storage(**kwargs)
  1. See DeleteBackendStorageRequestRequestTypeDef

delete_token#

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

Type annotations and code completion for