Skip to content

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#

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)
    ...
  1. See PlatformType
  2. See CustomRuleTypeDef
  3. See AutoBranchCreationConfigTypeDef
  4. 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.