AmplifyClient#
Auto-generated documentation for Amplify type annotations stubs module mypy-boto3-amplify.
AmplifyClient#
Type annotations and code completion for boto3.client("amplify").
boto3 documentation
# AmplifyClient usage example
from boto3.session import Session
from mypy_boto3_amplify.client import AmplifyClient
def get_amplify_client() -> AmplifyClient:
return Session().client("amplify")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("amplify").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("amplify")
try:
do_something(client)
except (
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.DependentServiceFailureException,
client.exceptions.InternalFailureException,
client.exceptions.LimitExceededException,
client.exceptions.NotFoundException,
client.exceptions.ResourceNotFoundException,
client.exceptions.UnauthorizedException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_amplify.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("amplify").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("amplify").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_app#
Creates a new Amplify app.
Type annotations and code completion for boto3.client("amplify").create_app method.
boto3 documentation
# create_app method definition
def create_app(
self,
*,
name: str,
description: str = ...,
repository: str = ...,
platform: PlatformType = ..., # (1)
iamServiceRoleArn: str = ...,
oauthToken: str = ...,
accessToken: str = ...,
environmentVariables: Mapping[str, str] = ...,
enableBranchAutoBuild: bool = ...,
enableBranchAutoDeletion: bool = ...,
enableBasicAuth: bool = ...,
basicAuthCredentials: str = ...,
customRules: Sequence[CustomRuleTypeDef] = ..., # (2)
tags: Mapping[str, str] = ...,
buildSpec: str = ...,
customHeaders: str = ...,
enableAutoBranchCreation: bool = ...,
autoBranchCreationPatterns: Sequence[str] = ...,
autoBranchCreationConfig: AutoBranchCreationConfigTypeDef = ..., # (3)
) -> CreateAppResultTypeDef: # (4)
...- See PlatformType
- See CustomRuleTypeDef
- See AutoBranchCreationConfigTypeDef
- See CreateAppResultTypeDef
# create_app method usage example with argument unpacking
kwargs: CreateAppRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_app(**kwargs)create_backend_environment#
Creates a new backend environment for an Amplify app.
Type annotations and code completion for boto3.client("amplify").create_backend_environment method.
boto3 documentation
# create_backend_environment method definition
def create_backend_environment(
self,
*,
appId: str,
environmentName: str,
stackName: str = ...,
deploymentArtifacts: str = ...,
) -> CreateBackendEnvironmentResultTypeDef: # (1)
...# create_backend_environment method usage example with argument unpacking
kwargs: CreateBackendEnvironmentRequestRequestTypeDef = { # (1)
"appId": ...,
"environmentName": ...,
}
parent.create_backend_environment(**kwargs)create_branch#
Creates a new branch for an Amplify app.
Type annotations and code completion for boto3.client("amplify").create_branch method.
boto3 documentation
# create_branch method definition
def create_branch(
self,
*,
appId: str,
branchName: str,
description: str = ...,
stage: StageType = ..., # (1)
framework: str = ...,
enableNotification: bool = ...,
enableAutoBuild: bool = ...,
environmentVariables: Mapping[str, str] = ...,
basicAuthCredentials: str = ...,
enableBasicAuth: bool = ...,
enablePerformanceMode: bool = ...,
tags: Mapping[str, str] = ...,
buildSpec: str = ...,
ttl: str = ...,
displayName: str = ...,
enablePullRequestPreview: bool = ...,
pullRequestEnvironmentName: str = ...,
backendEnvironmentArn: str = ...,
backend: BackendTypeDef = ..., # (2)
) -> CreateBranchResultTypeDef: # (3)
...- See StageType
- See BackendTypeDef
- See CreateBranchResultTypeDef
# create_branch method usage example with argument unpacking
kwargs: CreateBranchRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.create_branch(**kwargs)create_deployment#
Creates a deployment for a manually deployed Amplify app.
Type annotations and code completion for boto3.client("amplify").create_deployment method.
boto3 documentation
# create_deployment method definition
def create_deployment(
self,
*,
appId: str,
branchName: str,
fileMap: Mapping[str, str] = ...,
) -> CreateDeploymentResultTypeDef: # (1)
...# create_deployment method usage example with argument unpacking
kwargs: CreateDeploymentRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.create_deployment(**kwargs)create_domain_association#
Creates a new domain association for an Amplify app.
Type annotations and code completion for boto3.client("amplify").create_domain_association method.
boto3 documentation
# create_domain_association method definition
def create_domain_association(
self,
*,
appId: str,
domainName: str,
subDomainSettings: Sequence[SubDomainSettingTypeDef], # (1)
enableAutoSubDomain: bool = ...,
autoSubDomainCreationPatterns: Sequence[str] = ...,
autoSubDomainIAMRole: str = ...,
) -> CreateDomainAssociationResultTypeDef: # (2)
...# create_domain_association method usage example with argument unpacking
kwargs: CreateDomainAssociationRequestRequestTypeDef = { # (1)
"appId": ...,
"domainName": ...,
"subDomainSettings": ...,
}
parent.create_domain_association(**kwargs)create_webhook#
Creates a new webhook on an Amplify app.
Type annotations and code completion for boto3.client("amplify").create_webhook method.
boto3 documentation
# create_webhook method definition
def create_webhook(
self,
*,
appId: str,
branchName: str,
description: str = ...,
) -> CreateWebhookResultTypeDef: # (1)
...# create_webhook method usage example with argument unpacking
kwargs: CreateWebhookRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.create_webhook(**kwargs)delete_app#
Deletes an existing Amplify app specified by an app ID.
Type annotations and code completion for boto3.client("amplify").delete_app method.
boto3 documentation
# delete_app method definition
def delete_app(
self,
*,
appId: str,
) -> DeleteAppResultTypeDef: # (1)
...# delete_app method usage example with argument unpacking
kwargs: DeleteAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.delete_app(**kwargs)delete_backend_environment#
Deletes a backend environment for an Amplify app.
Type annotations and code completion for boto3.client("amplify").delete_backend_environment method.
boto3 documentation
# delete_backend_environment method definition
def delete_backend_environment(
self,
*,
appId: str,
environmentName: str,
) -> DeleteBackendEnvironmentResultTypeDef: # (1)
...# delete_backend_environment method usage example with argument unpacking
kwargs: DeleteBackendEnvironmentRequestRequestTypeDef = { # (1)
"appId": ...,
"environmentName": ...,
}
parent.delete_backend_environment(**kwargs)delete_branch#
Deletes a branch for an Amplify app.
Type annotations and code completion for boto3.client("amplify").delete_branch method.
boto3 documentation
# delete_branch method definition
def delete_branch(
self,
*,
appId: str,
branchName: str,
) -> DeleteBranchResultTypeDef: # (1)
...# delete_branch method usage example with argument unpacking
kwargs: DeleteBranchRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.delete_branch(**kwargs)delete_domain_association#
Deletes a domain association for an Amplify app.
Type annotations and code completion for boto3.client("amplify").delete_domain_association method.
boto3 documentation
# delete_domain_association method definition
def delete_domain_association(
self,
*,
appId: str,
domainName: str,
) -> DeleteDomainAssociationResultTypeDef: # (1)
...# delete_domain_association method usage example with argument unpacking
kwargs: DeleteDomainAssociationRequestRequestTypeDef = { # (1)
"appId": ...,
"domainName": ...,
}
parent.delete_domain_association(**kwargs)delete_job#
Deletes a job for a branch of an Amplify app.
Type annotations and code completion for boto3.client("amplify").delete_job method.
boto3 documentation
# delete_job method definition
def delete_job(
self,
*,
appId: str,
branchName: str,
jobId: str,
) -> DeleteJobResultTypeDef: # (1)
...# delete_job method usage example with argument unpacking
kwargs: DeleteJobRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
"jobId": ...,
}
parent.delete_job(**kwargs)delete_webhook#
Deletes a webhook.
Type annotations and code completion for boto3.client("amplify").delete_webhook method.
boto3 documentation
# delete_webhook method definition
def delete_webhook(
self,
*,
webhookId: str,
) -> DeleteWebhookResultTypeDef: # (1)
...# delete_webhook method usage example with argument unpacking
kwargs: DeleteWebhookRequestRequestTypeDef = { # (1)
"webhookId": ...,
}
parent.delete_webhook(**kwargs)generate_access_logs#
Returns the website access logs for a specific time range using a presigned URL.
Type annotations and code completion for boto3.client("amplify").generate_access_logs method.
boto3 documentation
# generate_access_logs method definition
def generate_access_logs(
self,
*,
domainName: str,
appId: str,
startTime: Union[datetime, str] = ...,
endTime: Union[datetime, str] = ...,
) -> GenerateAccessLogsResultTypeDef: # (1)
...# generate_access_logs method usage example with argument unpacking
kwargs: GenerateAccessLogsRequestRequestTypeDef = { # (1)
"domainName": ...,
"appId": ...,
}
parent.generate_access_logs(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("amplify").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:
...get_app#
Returns an existing Amplify app specified by an app ID.
Type annotations and code completion for boto3.client("amplify").get_app method.
boto3 documentation
# get_app method definition
def get_app(
self,
*,
appId: str,
) -> GetAppResultTypeDef: # (1)
...# get_app method usage example with argument unpacking
kwargs: GetAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.get_app(**kwargs)get_artifact_url#
Returns the artifact info that corresponds to an artifact id.
Type annotations and code completion for boto3.client("amplify").get_artifact_url method.
boto3 documentation
# get_artifact_url method definition
def get_artifact_url(
self,
*,
artifactId: str,
) -> GetArtifactUrlResultTypeDef: # (1)
...# get_artifact_url method usage example with argument unpacking
kwargs: GetArtifactUrlRequestRequestTypeDef = { # (1)
"artifactId": ...,
}
parent.get_artifact_url(**kwargs)- Se