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
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.
client = boto3.client("amplify")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.DependentServiceFailureException,
client.InternalFailureException,
client.LimitExceededException,
client.NotFoundException,
client.ResourceNotFoundException,
client.UnauthorizedException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("amplify").close
method.
boto3 documentation
create_app
Creates a new Amplify app.
Type annotations and code completion for boto3.client("amplify").create_app
method.
boto3 documentation
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
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
def create_backend_environment(
self,
*,
appId: str,
environmentName: str,
stackName: str = ...,
deploymentArtifacts: str = ...,
) -> CreateBackendEnvironmentResultTypeDef: # (1)
...
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
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 = ...,
) -> CreateBranchResultTypeDef: # (2)
...
- See StageType
- See CreateBranchResultTypeDef
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
def create_deployment(
self,
*,
appId: str,
branchName: str,
fileMap: Mapping[str, str] = ...,
) -> CreateDeploymentResultTypeDef: # (1)
...
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
def create_domain_association(
self,
*,
appId: str,
domainName: str,
subDomainSettings: Sequence[SubDomainSettingTypeDef], # (1)
enableAutoSubDomain: bool = ...,
autoSubDomainCreationPatterns: Sequence[str] = ...,
autoSubDomainIAMRole: str = ...,
) -> CreateDomainAssociationResultTypeDef: # (2)
...
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
def create_webhook(
self,
*,
appId: str,
branchName: str,
description: str = ...,
) -> CreateWebhookResultTypeDef: # (1)
...
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
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
def delete_backend_environment(
self,
*,
appId: str,
environmentName: str,
) -> DeleteBackendEnvironmentResultTypeDef: # (1)
...
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
def delete_branch(
self,
*,
appId: str,
branchName: str,
) -> DeleteBranchResultTypeDef: # (1)
...
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
def delete_domain_association(
self,
*,
appId: str,
domainName: str,
) -> DeleteDomainAssociationResultTypeDef: # (1)
...
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
def delete_job(
self,
*,
appId: str,
branchName: str,
jobId: str,
) -> DeleteJobResultTypeDef: # (1)
...
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
def delete_webhook(
self,
*,
webhookId: str,
) -> DeleteWebhookResultTypeDef: # (1)
...
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
def generate_access_logs(
self,
*,
domainName: str,
appId: str,
startTime: Union[datetime, str] = ...,
endTime: Union[datetime, str] = ...,
) -> GenerateAccessLogsResultTypeDef: # (1)
...
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
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_app
Returns an existing Amplify app by appID.
Type annotations and code completion for boto3.client("amplify").get_app
method.
boto3 documentation
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
def get_artifact_url(
self,
*,
artifactId: str,
) -> GetArtifactUrlResultTypeDef: # (1)
...
kwargs: GetArtifactUrlRequestRequestTypeDef = { # (1)
"artifactId": ...,
}
parent.get_artifact_url(**kwargs)
get_backend_environment
Returns a backend environment for an Amplify app.
Type annotations and code completion for boto3.client("amplify").get_backend_environment
method.
boto3 documentation
def get_backend_environment(
self,
*,
appId: str,
environmentName: str,
) -> GetBackendEnvironmentResultTypeDef: # (1)
...
kwargs: GetBackendEnvironmentRequestRequestTypeDef = { # (1)
"appId": ...,
"environmentName": ...,
}
parent.get_backend_environment(**kwargs)
get_branch
Returns a branch for an Amplify app.
Type annotations and code completion for boto3.client("amplify").get_branch
method.
boto3 documentation
def get_branch(
self,
*,
appId: str,
branchName: str,
) -> GetBranchResultTypeDef: # (1)
...
kwargs: GetBranchRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.get_branch(**kwargs)
get_domain_association
Returns the domain information for an Amplify app.
Type annotations and code completion for boto3.client("amplify").get_domain_association
method.
boto3 documentation
def get_domain_association(
self,
*,
appId: str,
domainName: str,
) -> GetDomainAssociationResultTypeDef: # (1)
...
kwargs: GetDomainAssociationRequestRequestTypeDef = { # (1)
"appId": ...,
"domainName": ...,
}
parent.get_domain_association(**kwargs)
get_job
Returns a job for a branch of an Amplify app.
Type annotations and code completion for boto3.client("amplify").get_job
method.
boto3 documentation
def get_job(
self,
*,
appId: str,
branchName: str,
jobId: str,
) -> GetJobResultTypeDef: # (1)
...
kwargs: GetJobRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
"jobId": ...,
}
parent.get_job(**kwargs)
get_webhook
Returns the webhook information that corresponds to a specified webhook ID.
Type annotations and code completion for boto3.client("amplify").get_webhook
method.
boto3 documentation
kwargs: GetWebhookRequestRequestTypeDef = { # (1)
"webhookId": ...,
}
parent.get_webhook(**kwargs)
list_apps
Returns a list of the existing Amplify apps.
Type annotations and code completion for boto3.client("amplify").list_apps
method.
boto3 documentation
def list_apps(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAppsResultTypeDef: # (1)
...
kwargs: ListAppsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_apps(**kwargs)
list_artifacts
Returns a list of artifacts for a specified app, branch, and job.
Type annotations and code completion for boto3.client("amplify").list_artifacts
method.
boto3 documentation
def list_artifacts(
self,
*,
appId: str,
branchName: str,
jobId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListArtifactsResultTypeDef: # (1)
...
kwargs: ListArtifactsRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
"jobId": ...,
}
parent.list_artifacts(**kwargs)
list_backend_environments
Lists the backend environments for an Amplify app.
Type annotations and code completion for boto3.client("amplify").list_backend_environments
method.
boto3 documentation
def list_backend_environments(
self,
*,
appId: str,
environmentName: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListBackendEnvironmentsResultTypeDef: # (1)
...
kwargs: ListBackendEnvironmentsRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.list_backend_environments(**kwargs)
list_branches
Lists the branches of an Amplify app.
Type annotations and code completion for boto3.client("amplify").list_branches
method.
boto3 documentation
def list_branches(
self,
*,
appId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListBranchesResultTypeDef: # (1)
...
kwargs: ListBranchesRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.list_branches(**kwargs)
list_domain_associations
Returns the domain associations for an Amplify app.
Type annotations and code completion for boto3.client("amplify").list_domain_associations
method.
boto3 documentation
def list_domain_associations(
self,
*,
appId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDomainAssociationsResultTypeDef: # (1)
...
kwargs: ListDomainAssociationsRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.list_domain_associations(**kwargs)
list_jobs
Lists the jobs for a branch of an Amplify app.
Type annotations and code completion for boto3.client("amplify").list_jobs
method.
boto3 documentation
def list_jobs(
self,
*,
appId: str,
branchName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListJobsResultTypeDef: # (1)
...
kwargs: ListJobsRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.list_jobs(**kwargs)
list_tags_for_resource
Returns a list of tags for a specified Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("amplify").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_webhooks
Returns a list of webhooks for an Amplify app.
Type annotations and code completion for boto3.client("amplify").list_webhooks
method.
boto3 documentation
def list_webhooks(
self,
*,
appId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListWebhooksResultTypeDef: # (1)
...
kwargs: ListWebhooksRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.list_webhooks(**kwargs)
start_deployment
Starts a deployment for a manually deployed app.
Type annotations and code completion for boto3.client("amplify").start_deployment
method.
boto3 documentation
def start_deployment(
self,
*,
appId: str,
branchName: str,
jobId: str = ...,
sourceUrl: str = ...,
) -> StartDeploymentResultTypeDef: # (1)
...
kwargs: StartDeploymentRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.start_deployment(**kwargs)
start_job
Starts a new job for a branch of an Amplify app.
Type annotations and code completion for boto3.client("amplify").start_job
method.
boto3 documentation
def start_job(
self,
*,
appId: str,
branchName: str,
jobType: JobTypeType, # (1)
jobId: str = ...,
jobReason: str = ...,
commitId: str = ...,
commitMessage: str = ...,
commitTime: Union[datetime, str] = ...,
) -> StartJobResultTypeDef: # (2)
...
- See JobTypeType
- See StartJobResultTypeDef
kwargs: StartJobRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
"jobType": ...,
}
parent.start_job(**kwargs)
stop_job
Stops a job that is in progress for a branch of an Amplify app.
Type annotations and code completion for boto3.client("amplify").stop_job
method.
boto3 documentation
def stop_job(
self,
*,
appId: str,
branchName: str,
jobId: str,
) -> StopJobResultTypeDef: # (1)
...
kwargs: StopJobRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
"jobId": ...,
}
parent.stop_job(**kwargs)
tag_resource
Tags the resource with a tag key and value.
Type annotations and code completion for boto3.client("amplify").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Untags a resource with a specified Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("amplify").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_app
Updates an existing Amplify app.
Type annotations and code completion for boto3.client("amplify").update_app
method.
boto3 documentation
def update_app(
self,
*,
appId: str,
name: str = ...,
description: str = ...,
platform: PlatformType = ..., # (1)
iamServiceRoleArn: str = ...,
environmentVariables: Mapping[str, str] = ...,
enableBranchAutoBuild: bool = ...,
enableBranchAutoDeletion: bool = ...,
enableBasicAuth: bool = ...,
basicAuthCredentials: str = ...,
customRules: Sequence[CustomRuleTypeDef] = ..., # (2)
buildSpec: str = ...,
customHeaders: str = ...,
enableAutoBranchCreation: bool = ...,
autoBranchCreationPatterns: Sequence[str] = ...,
autoBranchCreationConfig: AutoBranchCreationConfigTypeDef = ..., # (3)
repository: str = ...,
oauthToken: str = ...,
accessToken: str = ...,
) -> UpdateAppResultTypeDef: # (4)
...
- See PlatformType
- See CustomRuleTypeDef
- See AutoBranchCreationConfigTypeDef
- See UpdateAppResultTypeDef
kwargs: UpdateAppRequestRequestTypeDef = { # (1)
"appId": ...,
}
parent.update_app(**kwargs)
update_branch
Updates a branch for an Amplify app.
Type annotations and code completion for boto3.client("amplify").update_branch
method.
boto3 documentation
def update_branch(
self,
*,
appId: str,
branchName: str,
description: str = ...,
framework: str = ...,
stage: StageType = ..., # (1)
enableNotification: bool = ...,
enableAutoBuild: bool = ...,
environmentVariables: Mapping[str, str] = ...,
basicAuthCredentials: str = ...,
enableBasicAuth: bool = ...,
enablePerformanceMode: bool = ...,
buildSpec: str = ...,
ttl: str = ...,
displayName: str = ...,
enablePullRequestPreview: bool = ...,
pullRequestEnvironmentName: str = ...,
backendEnvironmentArn: str = ...,
) -> UpdateBranchResultTypeDef: # (2)
...
- See StageType
- See UpdateBranchResultTypeDef
kwargs: UpdateBranchRequestRequestTypeDef = { # (1)
"appId": ...,
"branchName": ...,
}
parent.update_branch(**kwargs)
update_domain_association
Creates a new domain association for an Amplify app.
Type annotations and code completion for boto3.client("amplify").update_domain_association
method.
boto3 documentation
def update_domain_association(
self,
*,
appId: str,
domainName: str,
enableAutoSubDomain: bool = ...,
subDomainSettings: Sequence[SubDomainSettingTypeDef] = ..., # (1)
autoSubDomainCreationPatterns: Sequence[str] = ...,
autoSubDomainIAMRole: str = ...,
) -> UpdateDomainAssociationResultTypeDef: # (2)
...
kwargs: UpdateDomainAssociationRequestRequestTypeDef = { # (1)
"appId": ...,
"domainName": ...,
}
parent.update_domain_association(**kwargs)
update_webhook
Updates a webhook.
Type annotations and code completion for boto3.client("amplify").update_webhook
method.
boto3 documentation
def update_webhook(
self,
*,
webhookId: str,
branchName: str = ...,
description: str = ...,
) -> UpdateWebhookResultTypeDef: # (1)
...
kwargs: UpdateWebhookRequestRequestTypeDef = { # (1)
"webhookId": ...,
}
parent.update_webhook(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("amplify").get_paginator
method with overloads.
client.get_paginator("list_apps")
-> ListAppsPaginatorclient.get_paginator("list_branches")
-> ListBranchesPaginatorclient.get_paginator("list_domain_associations")
-> ListDomainAssociationsPaginatorclient.get_paginator("list_jobs")
-> ListJobsPaginator