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
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.
client = boto3.client("amplifybackend")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.GatewayTimeoutException,
client.NotFoundException,
client.TooManyRequestsException,
) as e:
print(e)
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
clone_backend
This operation clones an existing backend.
Type annotations and code completion for boto3.client("amplifybackend").clone_backend
method.
boto3 documentation
def clone_backend(
self,
*,
AppId: str,
BackendEnvironmentName: str,
TargetEnvironmentName: str,
) -> CloneBackendResponseTypeDef: # (1)
...
kwargs: CloneBackendRequestRequestTypeDef = { # (1)
"AppId": ...,
"BackendEnvironmentName": ...,
"TargetEnvironmentName": ...,
}
parent.clone_backend(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("amplifybackend").close
method.
boto3 documentation
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
def create_backend(
self,
*,
AppId: str,
AppName: str,
BackendEnvironmentName: str,
ResourceConfig: Mapping[str, Any] = ...,
ResourceName: str = ...,
) -> CreateBackendResponseTypeDef: # (1)
...
kwargs: CreateBackendRequestRequestTypeDef = { # (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
def create_backend_api(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: BackendAPIResourceConfigTypeDef, # (1)
ResourceName: str,
) -> CreateBackendAPIResponseTypeDef: # (2)
...
kwargs: CreateBackendAPIRequestRequestTypeDef = { # (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
def create_backend_auth(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: CreateBackendAuthResourceConfigTypeDef, # (1)
ResourceName: str,
) -> CreateBackendAuthResponseTypeDef: # (2)
...
kwargs: CreateBackendAuthRequestRequestTypeDef = { # (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
def create_backend_config(
self,
*,
AppId: str,
BackendManagerAppId: str = ...,
) -> CreateBackendConfigResponseTypeDef: # (1)
...
kwargs: CreateBackendConfigRequestRequestTypeDef = { # (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
def create_backend_storage(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: CreateBackendStorageResourceConfigTypeDef, # (1)
ResourceName: str,
) -> CreateBackendStorageResponseTypeDef: # (2)
...
kwargs: CreateBackendStorageRequestRequestTypeDef = { # (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
kwargs: CreateTokenRequestRequestTypeDef = { # (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
def delete_backend(
self,
*,
AppId: str,
BackendEnvironmentName: str,
) -> DeleteBackendResponseTypeDef: # (1)
...
kwargs: DeleteBackendRequestRequestTypeDef = { # (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
def delete_backend_api(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ResourceConfig: BackendAPIResourceConfigTypeDef = ..., # (1)
) -> DeleteBackendAPIResponseTypeDef: # (2)
...
kwargs: DeleteBackendAPIRequestRequestTypeDef = { # (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
def delete_backend_auth(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
) -> DeleteBackendAuthResponseTypeDef: # (1)
...
kwargs: DeleteBackendAuthRequestRequestTypeDef = { # (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
def delete_backend_storage(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ServiceName: ServiceNameType, # (1)
) -> DeleteBackendStorageResponseTypeDef: # (2)
...
kwargs: DeleteBackendStorageRequestRequestTypeDef = { # (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
def delete_token(
self,
*,
AppId: str,
SessionId: str,
) -> DeleteTokenResponseTypeDef: # (1)
...
kwargs: DeleteTokenRequestRequestTypeDef = { # (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
def generate_backend_api_models(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
) -> GenerateBackendAPIModelsResponseTypeDef: # (1)
...
kwargs: GenerateBackendAPIModelsRequestRequestTypeDef = { # (1)
"AppId": ...,
"BackendEnvironmentName": ...,
"ResourceName": ...,
}
parent.generate_backend_api_models(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("amplifybackend").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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
def get_backend(
self,
*,
AppId: str,
BackendEnvironmentName: str = ...,
) -> GetBackendResponseTypeDef: # (1)
...
kwargs: GetBackendRequestRequestTypeDef = { # (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
def get_backend_api(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ResourceConfig: BackendAPIResourceConfigTypeDef = ..., # (1)
) -> GetBackendAPIResponseTypeDef: # (2)
...
kwargs: GetBackendAPIRequestRequestTypeDef = { # (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
def get_backend_api_models(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
) -> GetBackendAPIModelsResponseTypeDef: # (1)
...
kwargs: GetBackendAPIModelsRequestRequestTypeDef = { # (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
def get_backend_auth(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
) -> GetBackendAuthResponseTypeDef: # (1)
...
kwargs: GetBackendAuthRequestRequestTypeDef = { # (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
def get_backend_job(
self,
*,
AppId: str,
BackendEnvironmentName: str,
JobId: str,
) -> GetBackendJobResponseTypeDef: # (1)
...
kwargs: GetBackendJobRequestRequestTypeDef = { # (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
def get_backend_storage(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
) -> GetBackendStorageResponseTypeDef: # (1)
...
kwargs: GetBackendStorageRequestRequestTypeDef = { # (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
def get_token(
self,
*,
AppId: str,
SessionId: str,
) -> GetTokenResponseTypeDef: # (1)
...
kwargs: GetTokenRequestRequestTypeDef = { # (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
def import_backend_auth(
self,
*,
AppId: str,
BackendEnvironmentName: str,
NativeClientId: str,
UserPoolId: str,
WebClientId: str,
IdentityPoolId: str = ...,
) -> ImportBackendAuthResponseTypeDef: # (1)
...
kwargs: ImportBackendAuthRequestRequestTypeDef = { # (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
def import_backend_storage(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ServiceName: ServiceNameType, # (1)
BucketName: str = ...,
) -> ImportBackendStorageResponseTypeDef: # (2)
...
kwargs: ImportBackendStorageRequestRequestTypeDef = { # (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
def list_backend_jobs(
self,
*,
AppId: str,
BackendEnvironmentName: str,
JobId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
Operation: str = ...,
Status: str = ...,
) -> ListBackendJobsResponseTypeDef: # (1)
...
kwargs: ListBackendJobsRequestRequestTypeDef = { # (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
def list_s3_buckets(
self,
*,
NextToken: str = ...,
) -> ListS3BucketsResponseTypeDef: # (1)
...
kwargs: ListS3BucketsRequestRequestTypeDef = { # (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
def remove_all_backends(
self,
*,
AppId: str,
CleanAmplifyApp: bool = ...,
) -> RemoveAllBackendsResponseTypeDef: # (1)
...
kwargs: RemoveAllBackendsRequestRequestTypeDef = { # (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
def remove_backend_config(
self,
*,
AppId: str,
) -> RemoveBackendConfigResponseTypeDef: # (1)
...
kwargs: RemoveBackendConfigRequestRequestTypeDef = { # (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
def update_backend_api(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceName: str,
ResourceConfig: BackendAPIResourceConfigTypeDef = ..., # (1)
) -> UpdateBackendAPIResponseTypeDef: # (2)
...
kwargs: UpdateBackendAPIRequestRequestTypeDef = { # (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
def update_backend_auth(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: UpdateBackendAuthResourceConfigTypeDef, # (1)
ResourceName: str,
) -> UpdateBackendAuthResponseTypeDef: # (2)
...
kwargs: UpdateBackendAuthRequestRequestTypeDef = { # (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
def update_backend_config(
self,
*,
AppId: str,
LoginAuthConfig: LoginAuthConfigReqObjTypeDef = ..., # (1)
) -> UpdateBackendConfigResponseTypeDef: # (2)
...
kwargs: UpdateBackendConfigRequestRequestTypeDef = { # (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
def update_backend_job(
self,
*,
AppId: str,
BackendEnvironmentName: str,
JobId: str,
Operation: str = ...,
Status: str = ...,
) -> UpdateBackendJobResponseTypeDef: # (1)
...
kwargs: UpdateBackendJobRequestRequestTypeDef = { # (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
def update_backend_storage(
self,
*,
AppId: str,
BackendEnvironmentName: str,
ResourceConfig: UpdateBackendStorageResourceConfigTypeDef, # (1)
ResourceName: str,
) -> UpdateBackendStorageResponseTypeDef: # (2)
...
kwargs: UpdateBackendStorageRequestRequestTypeDef = { # (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