AmplifyClient

Index > Amplify > 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

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

generate_presigned_url

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

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)
    cacheConfig: CacheConfigTypeDef = ...,  # (4)
) -> CreateAppResultTypeDef:  # (5)
    ...

1. See PlatformType
2. See CustomRuleTypeDef
3. See AutoBranchCreationConfigTypeDef
4. See CacheConfigTypeDef
5. See CreateAppResultTypeDef

# create_app method usage example with argument unpacking

kwargs: CreateAppRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_app(**kwargs)

1. See CreateAppRequestRequestTypeDef

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

1. See CreateBackendEnvironmentResultTypeDef

# create_backend_environment method usage example with argument unpacking

kwargs: CreateBackendEnvironmentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.create_backend_environment(**kwargs)

1. See CreateBackendEnvironmentRequestRequestTypeDef

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

1. See StageType
2. See BackendTypeDef
3. See CreateBranchResultTypeDef

# create_branch method usage example with argument unpacking

kwargs: CreateBranchRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.create_branch(**kwargs)

1. See CreateBranchRequestRequestTypeDef

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

1. See CreateDeploymentResultTypeDef

# create_deployment method usage example with argument unpacking

kwargs: CreateDeploymentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.create_deployment(**kwargs)

1. See CreateDeploymentRequestRequestTypeDef

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 = ...,
    certificateSettings: CertificateSettingsTypeDef = ...,  # (2)
) -> CreateDomainAssociationResultTypeDef:  # (3)
    ...

1. See SubDomainSettingTypeDef
2. See CertificateSettingsTypeDef
3. See CreateDomainAssociationResultTypeDef

# create_domain_association method usage example with argument unpacking

kwargs: CreateDomainAssociationRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "domainName": ...,
    "subDomainSettings": ...,
}

parent.create_domain_association(**kwargs)

1. See CreateDomainAssociationRequestRequestTypeDef

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

1. See CreateWebhookResultTypeDef

# create_webhook method usage example with argument unpacking

kwargs: CreateWebhookRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.create_webhook(**kwargs)

1. See CreateWebhookRequestRequestTypeDef

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

1. See DeleteAppResultTypeDef

# delete_app method usage example with argument unpacking

kwargs: DeleteAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.delete_app(**kwargs)

1. See DeleteAppRequestRequestTypeDef

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

1. See DeleteBackendEnvironmentResultTypeDef

# delete_backend_environment method usage example with argument unpacking

kwargs: DeleteBackendEnvironmentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.delete_backend_environment(**kwargs)

1. See DeleteBackendEnvironmentRequestRequestTypeDef

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

1. See DeleteBranchResultTypeDef

# delete_branch method usage example with argument unpacking

kwargs: DeleteBranchRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.delete_branch(**kwargs)

1. See DeleteBranchRequestRequestTypeDef

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

1. See DeleteDomainAssociationResultTypeDef

# delete_domain_association method usage example with argument unpacking

kwargs: DeleteDomainAssociationRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "domainName": ...,
}

parent.delete_domain_association(**kwargs)

1. See DeleteDomainAssociationRequestRequestTypeDef

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

1. See DeleteJobResultTypeDef

# delete_job method usage example with argument unpacking

kwargs: DeleteJobRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
    "jobId": ...,
}

parent.delete_job(**kwargs)

1. See DeleteJobRequestRequestTypeDef

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

1. See DeleteWebhookResultTypeDef

# delete_webhook method usage example with argument unpacking

kwargs: DeleteWebhookRequestRequestTypeDef = {  # (1)
    "webhookId": ...,
}

parent.delete_webhook(**kwargs)

1. See DeleteWebhookRequestRequestTypeDef

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: TimestampTypeDef = ...,
    endTime: TimestampTypeDef = ...,
) -> GenerateAccessLogsResultTypeDef:  # (1)
    ...

1. See GenerateAccessLogsResultTypeDef

# generate_access_logs method usage example with argument unpacking

kwargs: GenerateAccessLogsRequestRequestTypeDef = {  # (1)
    "domainName": ...,
    "appId": ...,
}

parent.generate_access_logs(**kwargs)

1. See GenerateAccessLogsRequestRequestTypeDef

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

1. See GetAppResultTypeDef

# get_app method usage example with argument unpacking

kwargs: GetAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.get_app(**kwargs)

1. See GetAppRequestRequestTypeDef

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

1. See GetArtifactUrlResultTypeDef

# get_artifact_url method usage example with argument unpacking

kwargs: GetArtifactUrlRequestRequestTypeDef = {  # (1)
    "artifactId": ...,
}

parent.get_artifact_url(**kwargs)

1. See GetArtifactUrlRequestRequestTypeDef

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

# get_backend_environment method definition

def get_backend_environment(
    self,
    *,
    appId: str,
    environmentName: str,
) -> GetBackendEnvironmentResultTypeDef:  # (1)
    ...

1. See GetBackendEnvironmentResultTypeDef

# get_backend_environment method usage example with argument unpacking

kwargs: GetBackendEnvironmentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "environmentName": ...,
}

parent.get_backend_environment(**kwargs)

1. See GetBackendEnvironmentRequestRequestTypeDef

get_branch

Returns a branch for an Amplify app.

Type annotations and code completion for boto3.client("amplify").get_branch method. boto3 documentation

# get_branch method definition

def get_branch(
    self,
    *,
    appId: str,
    branchName: str,
) -> GetBranchResultTypeDef:  # (1)
    ...

1. See GetBranchResultTypeDef

# get_branch method usage example with argument unpacking

kwargs: GetBranchRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.get_branch(**kwargs)

1. See GetBranchRequestRequestTypeDef

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

# get_domain_association method definition

def get_domain_association(
    self,
    *,
    appId: str,
    domainName: str,
) -> GetDomainAssociationResultTypeDef:  # (1)
    ...

1. See GetDomainAssociationResultTypeDef

# get_domain_association method usage example with argument unpacking

kwargs: GetDomainAssociationRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "domainName": ...,
}

parent.get_domain_association(**kwargs)

1. See GetDomainAssociationRequestRequestTypeDef

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

# get_job method definition

def get_job(
    self,
    *,
    appId: str,
    branchName: str,
    jobId: str,
) -> GetJobResultTypeDef:  # (1)
    ...

1. See GetJobResultTypeDef

# get_job method usage example with argument unpacking

kwargs: GetJobRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
    "jobId": ...,
}

parent.get_job(**kwargs)

1. See GetJobRequestRequestTypeDef

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

# get_webhook method definition

def get_webhook(
    self,
    *,
    webhookId: str,
) -> GetWebhookResultTypeDef:  # (1)
    ...

1. See GetWebhookResultTypeDef

# get_webhook method usage example with argument unpacking

kwargs: GetWebhookRequestRequestTypeDef = {  # (1)
    "webhookId": ...,
}

parent.get_webhook(**kwargs)

1. See GetWebhookRequestRequestTypeDef

list_apps

Returns a list of the existing Amplify apps.

Type annotations and code completion for boto3.client("amplify").list_apps method. boto3 documentation

# list_apps method definition

def list_apps(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAppsResultTypeDef:  # (1)
    ...

1. See ListAppsResultTypeDef

# list_apps method usage example with argument unpacking

kwargs: ListAppsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_apps(**kwargs)

1. See ListAppsRequestRequestTypeDef

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

# list_artifacts method definition

def list_artifacts(
    self,
    *,
    appId: str,
    branchName: str,
    jobId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListArtifactsResultTypeDef:  # (1)
    ...

1. See ListArtifactsResultTypeDef

# list_artifacts method usage example with argument unpacking

kwargs: ListArtifactsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
    "jobId": ...,
}

parent.list_artifacts(**kwargs)

1. See ListArtifactsRequestRequestTypeDef

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

# list_backend_environments method definition

def list_backend_environments(
    self,
    *,
    appId: str,
    environmentName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListBackendEnvironmentsResultTypeDef:  # (1)
    ...

1. See ListBackendEnvironmentsResultTypeDef

# list_backend_environments method usage example with argument unpacking

kwargs: ListBackendEnvironmentsRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.list_backend_environments(**kwargs)

1. See ListBackendEnvironmentsRequestRequestTypeDef

list_branches

Lists the branches of an Amplify app.

Type annotations and code completion for boto3.client("amplify").list_branches method. boto3 documentation

# list_branches method definition

def list_branches(
    self,
    *,
    appId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListBranchesResultTypeDef:  # (1)
    ...

1. See ListBranchesResultTypeDef

# list_branches method usage example with argument unpacking

kwargs: ListBranchesRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.list_branches(**kwargs)

1. See ListBranchesRequestRequestTypeDef

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

# list_domain_associations method definition

def list_domain_associations(
    self,
    *,
    appId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDomainAssociationsResultTypeDef:  # (1)
    ...

1. See ListDomainAssociationsResultTypeDef

# list_domain_associations method usage example with argument unpacking

kwargs: ListDomainAssociationsRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.list_domain_associations(**kwargs)

1. See ListDomainAssociationsRequestRequestTypeDef

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

# list_jobs method definition

def list_jobs(
    self,
    *,
    appId: str,
    branchName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListJobsResultTypeDef:  # (1)
    ...

1. See ListJobsResultTypeDef

# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.list_jobs(**kwargs)

1. See ListJobsRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

# list_webhooks method definition

def list_webhooks(
    self,
    *,
    appId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListWebhooksResultTypeDef:  # (1)
    ...

1. See ListWebhooksResultTypeDef

# list_webhooks method usage example with argument unpacking

kwargs: ListWebhooksRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.list_webhooks(**kwargs)

1. See ListWebhooksRequestRequestTypeDef

start_deployment

Starts a deployment for a manually deployed app.

Type annotations and code completion for boto3.client("amplify").start_deployment method. boto3 documentation

# start_deployment method definition

def start_deployment(
    self,
    *,
    appId: str,
    branchName: str,
    jobId: str = ...,
    sourceUrl: str = ...,
    sourceUrlType: SourceUrlTypeType = ...,  # (1)
) -> StartDeploymentResultTypeDef:  # (2)
    ...

1. See SourceUrlTypeType
2. See StartDeploymentResultTypeDef

# start_deployment method usage example with argument unpacking

kwargs: StartDeploymentRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.start_deployment(**kwargs)

1. See StartDeploymentRequestRequestTypeDef

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

# start_job method definition

def start_job(
    self,
    *,
    appId: str,
    branchName: str,
    jobType: JobTypeType,  # (1)
    jobId: str = ...,
    jobReason: str = ...,
    commitId: str = ...,
    commitMessage: str = ...,
    commitTime: TimestampTypeDef = ...,
) -> StartJobResultTypeDef:  # (2)
    ...

1. See JobTypeType
2. See StartJobResultTypeDef

# start_job method usage example with argument unpacking

kwargs: StartJobRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
    "jobType": ...,
}

parent.start_job(**kwargs)

1. See StartJobRequestRequestTypeDef

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

# stop_job method definition

def stop_job(
    self,
    *,
    appId: str,
    branchName: str,
    jobId: str,
) -> StopJobResultTypeDef:  # (1)
    ...

1. See StopJobResultTypeDef

# stop_job method usage example with argument unpacking

kwargs: StopJobRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
    "jobId": ...,
}

parent.stop_job(**kwargs)

1. See StopJobRequestRequestTypeDef

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_app

Updates an existing Amplify app.

Type annotations and code completion for boto3.client("amplify").update_app method. boto3 documentation

# update_app method definition

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 = ...,
    cacheConfig: CacheConfigTypeDef = ...,  # (4)
) -> UpdateAppResultTypeDef:  # (5)
    ...

1. See PlatformType
2. See CustomRuleTypeDef
3. See AutoBranchCreationConfigTypeDef
4. See CacheConfigTypeDef
5. See UpdateAppResultTypeDef

# update_app method usage example with argument unpacking

kwargs: UpdateAppRequestRequestTypeDef = {  # (1)
    "appId": ...,
}

parent.update_app(**kwargs)

1. See UpdateAppRequestRequestTypeDef

update_branch

Updates a branch for an Amplify app.

Type annotations and code completion for boto3.client("amplify").update_branch method. boto3 documentation

# update_branch method definition

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 = ...,
    backend: BackendTypeDef = ...,  # (2)
) -> UpdateBranchResultTypeDef:  # (3)
    ...

1. See StageType
2. See BackendTypeDef
3. See UpdateBranchResultTypeDef

# update_branch method usage example with argument unpacking

kwargs: UpdateBranchRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "branchName": ...,
}

parent.update_branch(**kwargs)

1. See UpdateBranchRequestRequestTypeDef

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

# update_domain_association method definition

def update_domain_association(
    self,
    *,
    appId: str,
    domainName: str,
    enableAutoSubDomain: bool = ...,
    subDomainSettings: Sequence[SubDomainSettingTypeDef] = ...,  # (1)
    autoSubDomainCreationPatterns: Sequence[str] = ...,
    autoSubDomainIAMRole: str = ...,
    certificateSettings: CertificateSettingsTypeDef = ...,  # (2)
) -> UpdateDomainAssociationResultTypeDef:  # (3)
    ...

1. See SubDomainSettingTypeDef
2. See CertificateSettingsTypeDef
3. See UpdateDomainAssociationResultTypeDef

# update_domain_association method usage example with argument unpacking

kwargs: UpdateDomainAssociationRequestRequestTypeDef = {  # (1)
    "appId": ...,
    "domainName": ...,
}

parent.update_domain_association(**kwargs)

1. See UpdateDomainAssociationRequestRequestTypeDef

update_webhook

Updates a webhook.

Type annotations and code completion for boto3.client("amplify").update_webhook method. boto3 documentation

# update_webhook method definition

def update_webhook(
    self,
    *,
    webhookId: str,
    branchName: str = ...,
    description: str = ...,
) -> UpdateWebhookResultTypeDef:  # (1)
    ...

1. See UpdateWebhookResultTypeDef

# update_webhook method usage example with argument unpacking

kwargs: UpdateWebhookRequestRequestTypeDef = {  # (1)
    "webhookId": ...,
}

parent.update_webhook(**kwargs)

1. See UpdateWebhookRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("amplify").get_paginator method with overloads.

• client.get_paginator("list_apps") -> ListAppsPaginator
• client.get_paginator("list_branches") -> ListBranchesPaginator
• client.get_paginator("list_domain_associations") -> ListDomainAssociationsPaginator
• client.get_paginator("list_jobs") -> ListJobsPaginator