AWS API Changes

2020/06/24 - AWS Amplify - 10 updated api methods

Changes Update amplify client to latest version

CreateApp (updated)

Link ¶
Changes (request, response)
Request

{'enableBranchAutoDeletion': 'boolean'}

Response

{'app': {'enableBranchAutoDeletion': 'boolean'}}

Creates a new Amplify app.

See also: AWS API Documentation

Request Syntax

client.create_app(
    name='string',
    description='string',
    repository='string',
    platform='WEB',
    iamServiceRoleArn='string',
    oauthToken='string',
    accessToken='string',
    environmentVariables={
        'string': 'string'
    },
    enableBranchAutoBuild=True|False,
    enableBranchAutoDeletion=True|False,
    enableBasicAuth=True|False,
    basicAuthCredentials='string',
    customRules=[
        {
            'source': 'string',
            'target': 'string',
            'status': 'string',
            'condition': 'string'
        },
    ],
    tags={
        'string': 'string'
    },
    buildSpec='string',
    enableAutoBranchCreation=True|False,
    autoBranchCreationPatterns=[
        'string',
    ],
    autoBranchCreationConfig={
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
        'framework': 'string',
        'enableAutoBuild': True|False,
        'environmentVariables': {
            'string': 'string'
        },
        'basicAuthCredentials': 'string',
        'enableBasicAuth': True|False,
        'buildSpec': 'string',
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name for the Amplify app.

type description:

string

param description:

The description for an Amplify app.

type repository:

string

param repository:

The repository for an Amplify app.

type platform:

string

param platform:

The platform or framework for an Amplify app.

type iamServiceRoleArn:

string

param iamServiceRoleArn:

The AWS Identity and Access Management (IAM) service role for an Amplify app.

type oauthToken:

string

param oauthToken:

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

type accessToken:

string

param accessToken:

The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.

type environmentVariables:

dict

param environmentVariables:

The environment variables map for an Amplify app.

(string) --
- (string) --

type enableBranchAutoBuild:

boolean

param enableBranchAutoBuild:

Enables the auto building of branches for an Amplify app.

type enableBranchAutoDeletion:

boolean

param enableBranchAutoDeletion:

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

type basicAuthCredentials:

string

param basicAuthCredentials:

The credentials for basic authorization for an Amplify app.

type customRules:

list

param customRules:

The custom rewrite and redirect rules for an Amplify app.

(dict) --

Describes a custom rewrite or redirect rule.
- source (string) -- [REQUIRED]
  
  The source pattern for a URL rewrite or redirect rule.
- target (string) -- [REQUIRED]
  
  The target pattern for a URL rewrite or redirect rule.
- status (string) --
  
  The status code for a URL rewrite or redirect rule.
- condition (string) --
  
  The condition for a URL rewrite or redirect rule, such as a country code.

type tags:

dict

param tags:

The tag for an Amplify app.

(string) --
- (string) --

type buildSpec:

string

param buildSpec:

The build specification (build spec) for an Amplify app.

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for the Amplify app.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

The automated branch creation glob patterns for the Amplify app.

(string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

The automated branch creation configuration for the Amplify app.

stage (string) --

Describes the current stage for the autocreated branch.
framework (string) --

The framework for the autocreated branch.
enableAutoBuild (boolean) --

Enables auto building for the autocreated branch.
environmentVariables (dict) --

The environment variables for the autocreated branch.
- (string) --
  - (string) --
basicAuthCredentials (string) --

The basic authorization credentials for the autocreated branch.
enableBasicAuth (boolean) --

Enables basic authorization for the autocreated branch.
buildSpec (string) --

The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --

Enables pull request preview for the autocreated branch.
pullRequestEnvironmentName (string) --

The Amplify environment name for the pull request.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBranchAutoDeletion': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
            'framework': 'string',
            'enableAutoBuild': True|False,
            'environmentVariables': {
                'string': 'string'
            },
            'basicAuthCredentials': 'string',
            'enableBasicAuth': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

(dict) --
- app (dict) --
  
  Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
  - appId (string) --
    
    The unique ID of the Amplify app.
  - appArn (string) --
    
    The Amazon Resource Name (ARN) of the Amplify app.
  - name (string) --
    
    The name for the Amplify app.
  - tags (dict) --
    
    The tag for the Amplify app.
    - (string) --
      - (string) --
  - description (string) --
    
    The description for the Amplify app.
  - repository (string) --
    
    The repository for the Amplify app.
  - platform (string) --
    
    The platform for the Amplify app.
  - createTime (datetime) --
    
    Creates a date and time for the Amplify app.
  - updateTime (datetime) --
    
    Updates the date and time for the Amplify app.
  - iamServiceRoleArn (string) --
    
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
  - environmentVariables (dict) --
    
    The environment variables for the Amplify app.
    - (string) --
      - (string) --
  - defaultDomain (string) --
    
    The default domain for the Amplify app.
  - enableBranchAutoBuild (boolean) --
    
    Enables the auto-building of branches for the Amplify app.
  - enableBranchAutoDeletion (boolean) --
    
    Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
  - enableBasicAuth (boolean) --
    
    Enables basic authorization for the Amplify app's branches.
  - basicAuthCredentials (string) --
    
    The basic authorization credentials for branches for the Amplify app.
  - customRules (list) --
    
    Describes the custom redirect and rewrite rules for the Amplify app.
    - (dict) --
      
      Describes a custom rewrite or redirect rule.
      - source (string) --
        
        The source pattern for a URL rewrite or redirect rule.
      - target (string) --
        
        The target pattern for a URL rewrite or redirect rule.
      - status (string) --
        
        The status code for a URL rewrite or redirect rule.
      - condition (string) --
        
        The condition for a URL rewrite or redirect rule, such as a country code.
  - productionBranch (dict) --
    
    Describes the information about a production branch of the Amplify app.
    - lastDeployTime (datetime) --
      
      The last deploy time of the production branch.
    - status (string) --
      
      The status of the production branch.
    - thumbnailUrl (string) --
      
      The thumbnail URL for the production branch.
    - branchName (string) --
      
      The branch name for the production branch.
  - buildSpec (string) --
    
    Describes the content of the build specification (build spec) for the Amplify app.
  - enableAutoBranchCreation (boolean) --
    
    Enables automated branch creation for the Amplify app.
  - autoBranchCreationPatterns (list) --
    
    Describes the automated branch creation glob patterns for the Amplify app.
    - (string) --
  - autoBranchCreationConfig (dict) --
    
    Describes the automated branch creation configuration for the Amplify app.
    - stage (string) --
      
      Describes the current stage for the autocreated branch.
    - framework (string) --
      
      The framework for the autocreated branch.
    - enableAutoBuild (boolean) --
      
      Enables auto building for the autocreated branch.
    - environmentVariables (dict) --
      
      The environment variables for the autocreated branch.
      - (string) --
        
        (string) --
    - basicAuthCredentials (string) --
      
      The basic authorization credentials for the autocreated branch.
    - enableBasicAuth (boolean) --
      
      Enables basic authorization for the autocreated branch.
    - buildSpec (string) --
      
      The build specification (build spec) for the autocreated branch.
    - enablePullRequestPreview (boolean) --
      
      Enables pull request preview for the autocreated branch.
    - pullRequestEnvironmentName (string) --
      
      The Amplify environment name for the pull request.

CreateDomainAssociation (updated)

Link ¶
Changes (request, response)
Request

{'autoSubDomainCreationPatterns': ['string'], 'autoSubDomainIAMRole': 'string'}

Response

{'domainAssociation': {'autoSubDomainCreationPatterns': ['string'],
                       'autoSubDomainIAMRole': 'string'}}

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

See also: AWS API Documentation

Request Syntax

client.create_domain_association(
    appId='string',
    domainName='string',
    enableAutoSubDomain=True|False,
    subDomainSettings=[
        {
            'prefix': 'string',
            'branchName': 'string'
        },
    ],
    autoSubDomainCreationPatterns=[
        'string',
    ],
    autoSubDomainIAMRole='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type domainName:

string

param domainName:

[REQUIRED]

The domain name for the domain association.

type enableAutoSubDomain:

boolean

param enableAutoSubDomain:

Enables the automated creation of subdomains for branches.

type subDomainSettings:

list

param subDomainSettings:

[REQUIRED]

The setting for the subdomain.

(dict) --

Describes the settings for the subdomain.
- prefix (string) -- [REQUIRED]
  
  The prefix setting for the subdomain.
- branchName (string) -- [REQUIRED]
  
  The branch name setting for the subdomain.

type autoSubDomainCreationPatterns:

list

param autoSubDomainCreationPatterns:

Sets the branch patterns for automatic subdomain creation.

(string) --

type autoSubDomainIAMRole:

string

param autoSubDomainIAMRole:

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

rtype:

dict

returns:

Response Syntax

{
    'domainAssociation': {
        'domainAssociationArn': 'string',
        'domainName': 'string',
        'enableAutoSubDomain': True|False,
        'autoSubDomainCreationPatterns': [
            'string',
        ],
        'autoSubDomainIAMRole': 'string',
        'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
        'statusReason': 'string',
        'certificateVerificationDNSRecord': 'string',
        'subDomains': [
            {
                'subDomainSetting': {
                    'prefix': 'string',
                    'branchName': 'string'
                },
                'verified': True|False,
                'dnsRecord': 'string'
            },
        ]
    }
}

Response Structure

(dict) --

The result structure for the create domain association request.
- domainAssociation (dict) --
  
  Describes the structure of a domain association, which associates a custom domain with an Amplify app.
  - domainAssociationArn (string) --
    
    The Amazon Resource Name (ARN) for the domain association.
  - domainName (string) --
    
    The name of the domain.
  - enableAutoSubDomain (boolean) --
    
    Enables the automated creation of subdomains for branches.
  - autoSubDomainCreationPatterns (list) --
    
    Sets branch patterns for automatic subdomain creation.
    - (string) --
  - autoSubDomainIAMRole (string) --
    
    The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
  - domainStatus (string) --
    
    The current status of the domain association.
  - statusReason (string) --
    
    The reason for the current status of the domain association.
  - certificateVerificationDNSRecord (string) --
    
    The DNS record for certificate verification.
  - subDomains (list) --
    
    The subdomains for the domain association.
    - (dict) --
      
      The subdomain for the domain association.
      - subDomainSetting (dict) --
        
        Describes the settings for the subdomain.
        
        prefix (string) --
        
        The prefix setting for the subdomain.
        
        branchName (string) --
        
        The branch name setting for the subdomain.
      - verified (boolean) --
        
        The verified status of the subdomain
      - dnsRecord (string) --
        
        The DNS record for the subdomain.

DeleteApp (updated)

Link ¶
Changes (response)

{'app': {'enableBranchAutoDeletion': 'boolean'}}

Deletes an existing Amplify app specified by an app ID.

See also: AWS API Documentation

Request Syntax

client.delete_app(
    appId='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBranchAutoDeletion': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
            'framework': 'string',
            'enableAutoBuild': True|False,
            'environmentVariables': {
                'string': 'string'
            },
            'basicAuthCredentials': 'string',
            'enableBasicAuth': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

(dict) --

The result structure for the delete app request.
- app (dict) --
  
  Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
  - appId (string) --
    
    The unique ID of the Amplify app.
  - appArn (string) --
    
    The Amazon Resource Name (ARN) of the Amplify app.
  - name (string) --
    
    The name for the Amplify app.
  - tags (dict) --
    
    The tag for the Amplify app.
    - (string) --
      - (string) --
  - description (string) --
    
    The description for the Amplify app.
  - repository (string) --
    
    The repository for the Amplify app.
  - platform (string) --
    
    The platform for the Amplify app.
  - createTime (datetime) --
    
    Creates a date and time for the Amplify app.
  - updateTime (datetime) --
    
    Updates the date and time for the Amplify app.
  - iamServiceRoleArn (string) --
    
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
  - environmentVariables (dict) --
    
    The environment variables for the Amplify app.
    - (string) --
      - (string) --
  - defaultDomain (string) --
    
    The default domain for the Amplify app.
  - enableBranchAutoBuild (boolean) --
    
    Enables the auto-building of branches for the Amplify app.
  - enableBranchAutoDeletion (boolean) --
    
    Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
  - enableBasicAuth (boolean) --
    
    Enables basic authorization for the Amplify app's branches.
  - basicAuthCredentials (string) --
    
    The basic authorization credentials for branches for the Amplify app.
  - customRules (list) --
    
    Describes the custom redirect and rewrite rules for the Amplify app.
    - (dict) --
      
      Describes a custom rewrite or redirect rule.
      - source (string) --
        
        The source pattern for a URL rewrite or redirect rule.
      - target (string) --
        
        The target pattern for a URL rewrite or redirect rule.
      - status (string) --
        
        The status code for a URL rewrite or redirect rule.
      - condition (string) --
        
        The condition for a URL rewrite or redirect rule, such as a country code.
  - productionBranch (dict) --
    
    Describes the information about a production branch of the Amplify app.
    - lastDeployTime (datetime) --
      
      The last deploy time of the production branch.
    - status (string) --
      
      The status of the production branch.
    - thumbnailUrl (string) --
      
      The thumbnail URL for the production branch.
    - branchName (string) --
      
      The branch name for the production branch.
  - buildSpec (string) --
    
    Describes the content of the build specification (build spec) for the Amplify app.
  - enableAutoBranchCreation (boolean) --
    
    Enables automated branch creation for the Amplify app.
  - autoBranchCreationPatterns (list) --
    
    Describes the automated branch creation glob patterns for the Amplify app.
    - (string) --
  - autoBranchCreationConfig (dict) --
    
    Describes the automated branch creation configuration for the Amplify app.
    - stage (string) --
      
      Describes the current stage for the autocreated branch.
    - framework (string) --
      
      The framework for the autocreated branch.
    - enableAutoBuild (boolean) --
      
      Enables auto building for the autocreated branch.
    - environmentVariables (dict) --
      
      The environment variables for the autocreated branch.
      - (string) --
        
        (string) --
    - basicAuthCredentials (string) --
      
      The basic authorization credentials for the autocreated branch.
    - enableBasicAuth (boolean) --
      
      Enables basic authorization for the autocreated branch.
    - buildSpec (string) --
      
      The build specification (build spec) for the autocreated branch.
    - enablePullRequestPreview (boolean) --
      
      Enables pull request preview for the autocreated branch.
    - pullRequestEnvironmentName (string) --
      
      The Amplify environment name for the pull request.

DeleteDomainAssociation (updated)

Link ¶
Changes (response)

{'domainAssociation': {'autoSubDomainCreationPatterns': ['string'],
                       'autoSubDomainIAMRole': 'string'}}

Deletes a domain association for an Amplify app.

See also: AWS API Documentation

Request Syntax

client.delete_domain_association(
    appId='string',
    domainName='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique id for an Amplify app.

type domainName:

string

param domainName:

[REQUIRED]

The name of the domain.

rtype:

dict

returns:

Response Syntax

{
    'domainAssociation': {
        'domainAssociationArn': 'string',
        'domainName': 'string',
        'enableAutoSubDomain': True|False,
        'autoSubDomainCreationPatterns': [
            'string',
        ],
        'autoSubDomainIAMRole': 'string',
        'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
        'statusReason': 'string',
        'certificateVerificationDNSRecord': 'string',
        'subDomains': [
            {
                'subDomainSetting': {
                    'prefix': 'string',
                    'branchName': 'string'
                },
                'verified': True|False,
                'dnsRecord': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- domainAssociation (dict) --
  
  Describes a domain association that associates a custom domain with an Amplify app.
  - domainAssociationArn (string) --
    
    The Amazon Resource Name (ARN) for the domain association.
  - domainName (string) --
    
    The name of the domain.
  - enableAutoSubDomain (boolean) --
    
    Enables the automated creation of subdomains for branches.
  - autoSubDomainCreationPatterns (list) --
    
    Sets branch patterns for automatic subdomain creation.
    - (string) --
  - autoSubDomainIAMRole (string) --
    
    The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
  - domainStatus (string) --
    
    The current status of the domain association.
  - statusReason (string) --
    
    The reason for the current status of the domain association.
  - certificateVerificationDNSRecord (string) --
    
    The DNS record for certificate verification.
  - subDomains (list) --
    
    The subdomains for the domain association.
    - (dict) --
      
      The subdomain for the domain association.
      - subDomainSetting (dict) --
        
        Describes the settings for the subdomain.
        
        prefix (string) --
        
        The prefix setting for the subdomain.
        
        branchName (string) --
        
        The branch name setting for the subdomain.
      - verified (boolean) --
        
        The verified status of the subdomain
      - dnsRecord (string) --
        
        The DNS record for the subdomain.

GetApp (updated)

Link ¶
Changes (response)

{'app': {'enableBranchAutoDeletion': 'boolean'}}

Returns an existing Amplify app by appID.

See also: AWS API Documentation

Request Syntax

client.get_app(
    appId='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBranchAutoDeletion': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
            'framework': 'string',
            'enableAutoBuild': True|False,
            'environmentVariables': {
                'string': 'string'
            },
            'basicAuthCredentials': 'string',
            'enableBasicAuth': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

(dict) --
- app (dict) --
  
  Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
  - appId (string) --
    
    The unique ID of the Amplify app.
  - appArn (string) --
    
    The Amazon Resource Name (ARN) of the Amplify app.
  - name (string) --
    
    The name for the Amplify app.
  - tags (dict) --
    
    The tag for the Amplify app.
    - (string) --
      - (string) --
  - description (string) --
    
    The description for the Amplify app.
  - repository (string) --
    
    The repository for the Amplify app.
  - platform (string) --
    
    The platform for the Amplify app.
  - createTime (datetime) --
    
    Creates a date and time for the Amplify app.
  - updateTime (datetime) --
    
    Updates the date and time for the Amplify app.
  - iamServiceRoleArn (string) --
    
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
  - environmentVariables (dict) --
    
    The environment variables for the Amplify app.
    - (string) --
      - (string) --
  - defaultDomain (string) --
    
    The default domain for the Amplify app.
  - enableBranchAutoBuild (boolean) --
    
    Enables the auto-building of branches for the Amplify app.
  - enableBranchAutoDeletion (boolean) --
    
    Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
  - enableBasicAuth (boolean) --
    
    Enables basic authorization for the Amplify app's branches.
  - basicAuthCredentials (string) --
    
    The basic authorization credentials for branches for the Amplify app.
  - customRules (list) --
    
    Describes the custom redirect and rewrite rules for the Amplify app.
    - (dict) --
      
      Describes a custom rewrite or redirect rule.
      - source (string) --
        
        The source pattern for a URL rewrite or redirect rule.
      - target (string) --
        
        The target pattern for a URL rewrite or redirect rule.
      - status (string) --
        
        The status code for a URL rewrite or redirect rule.
      - condition (string) --
        
        The condition for a URL rewrite or redirect rule, such as a country code.
  - productionBranch (dict) --
    
    Describes the information about a production branch of the Amplify app.
    - lastDeployTime (datetime) --
      
      The last deploy time of the production branch.
    - status (string) --
      
      The status of the production branch.
    - thumbnailUrl (string) --
      
      The thumbnail URL for the production branch.
    - branchName (string) --
      
      The branch name for the production branch.
  - buildSpec (string) --
    
    Describes the content of the build specification (build spec) for the Amplify app.
  - enableAutoBranchCreation (boolean) --
    
    Enables automated branch creation for the Amplify app.
  - autoBranchCreationPatterns (list) --
    
    Describes the automated branch creation glob patterns for the Amplify app.
    - (string) --
  - autoBranchCreationConfig (dict) --
    
    Describes the automated branch creation configuration for the Amplify app.
    - stage (string) --
      
      Describes the current stage for the autocreated branch.
    - framework (string) --
      
      The framework for the autocreated branch.
    - enableAutoBuild (boolean) --
      
      Enables auto building for the autocreated branch.
    - environmentVariables (dict) --
      
      The environment variables for the autocreated branch.
      - (string) --
        
        (string) --
    - basicAuthCredentials (string) --
      
      The basic authorization credentials for the autocreated branch.
    - enableBasicAuth (boolean) --
      
      Enables basic authorization for the autocreated branch.
    - buildSpec (string) --
      
      The build specification (build spec) for the autocreated branch.
    - enablePullRequestPreview (boolean) --
      
      Enables pull request preview for the autocreated branch.
    - pullRequestEnvironmentName (string) --
      
      The Amplify environment name for the pull request.

GetDomainAssociation (updated)

Link ¶
Changes (response)

{'domainAssociation': {'autoSubDomainCreationPatterns': ['string'],
                       'autoSubDomainIAMRole': 'string'}}

Returns the domain information for an Amplify app.

See also: AWS API Documentation

Request Syntax

client.get_domain_association(
    appId='string',
    domainName='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique id for an Amplify app.

type domainName:

string

param domainName:

[REQUIRED]

The name of the domain.

rtype:

dict

returns:

Response Syntax

{
    'domainAssociation': {
        'domainAssociationArn': 'string',
        'domainName': 'string',
        'enableAutoSubDomain': True|False,
        'autoSubDomainCreationPatterns': [
            'string',
        ],
        'autoSubDomainIAMRole': 'string',
        'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
        'statusReason': 'string',
        'certificateVerificationDNSRecord': 'string',
        'subDomains': [
            {
                'subDomainSetting': {
                    'prefix': 'string',
                    'branchName': 'string'
                },
                'verified': True|False,
                'dnsRecord': 'string'
            },
        ]
    }
}

Response Structure

(dict) --

The result structure for the get domain association request.
- domainAssociation (dict) --
  
  Describes the structure of a domain association, which associates a custom domain with an Amplify app.
  - domainAssociationArn (string) --
    
    The Amazon Resource Name (ARN) for the domain association.
  - domainName (string) --
    
    The name of the domain.
  - enableAutoSubDomain (boolean) --
    
    Enables the automated creation of subdomains for branches.
  - autoSubDomainCreationPatterns (list) --
    
    Sets branch patterns for automatic subdomain creation.
    - (string) --
  - autoSubDomainIAMRole (string) --
    
    The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
  - domainStatus (string) --
    
    The current status of the domain association.
  - statusReason (string) --
    
    The reason for the current status of the domain association.
  - certificateVerificationDNSRecord (string) --
    
    The DNS record for certificate verification.
  - subDomains (list) --
    
    The subdomains for the domain association.
    - (dict) --
      
      The subdomain for the domain association.
      - subDomainSetting (dict) --
        
        Describes the settings for the subdomain.
        
        prefix (string) --
        
        The prefix setting for the subdomain.
        
        branchName (string) --
        
        The branch name setting for the subdomain.
      - verified (boolean) --
        
        The verified status of the subdomain
      - dnsRecord (string) --
        
        The DNS record for the subdomain.

ListApps (updated)

Link ¶
Changes (response)

{'apps': {'enableBranchAutoDeletion': 'boolean'}}

Returns a list of the existing Amplify apps.

See also: AWS API Documentation

Request Syntax

client.list_apps(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

type maxResults:

integer

param maxResults:

The maximum number of records to list in a single response.

rtype:

dict

returns:

Response Syntax

{
    'apps': [
        {
            'appId': 'string',
            'appArn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            },
            'description': 'string',
            'repository': 'string',
            'platform': 'WEB',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'iamServiceRoleArn': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'defaultDomain': 'string',
            'enableBranchAutoBuild': True|False,
            'enableBranchAutoDeletion': True|False,
            'enableBasicAuth': True|False,
            'basicAuthCredentials': 'string',
            'customRules': [
                {
                    'source': 'string',
                    'target': 'string',
                    'status': 'string',
                    'condition': 'string'
                },
            ],
            'productionBranch': {
                'lastDeployTime': datetime(2015, 1, 1),
                'status': 'string',
                'thumbnailUrl': 'string',
                'branchName': 'string'
            },
            'buildSpec': 'string',
            'enableAutoBranchCreation': True|False,
            'autoBranchCreationPatterns': [
                'string',
            ],
            'autoBranchCreationConfig': {
                'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
                'framework': 'string',
                'enableAutoBuild': True|False,
                'environmentVariables': {
                    'string': 'string'
                },
                'basicAuthCredentials': 'string',
                'enableBasicAuth': True|False,
                'buildSpec': 'string',
                'enablePullRequestPreview': True|False,
                'pullRequestEnvironmentName': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

The result structure for an Amplify app list request.
- apps (list) --
  
  A list of Amplify apps.
  - (dict) --
    
    Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
    - appId (string) --
      
      The unique ID of the Amplify app.
    - appArn (string) --
      
      The Amazon Resource Name (ARN) of the Amplify app.
    - name (string) --
      
      The name for the Amplify app.
    - tags (dict) --
      
      The tag for the Amplify app.
      - (string) --
        
        (string) --
    - description (string) --
      
      The description for the Amplify app.
    - repository (string) --
      
      The repository for the Amplify app.
    - platform (string) --
      
      The platform for the Amplify app.
    - createTime (datetime) --
      
      Creates a date and time for the Amplify app.
    - updateTime (datetime) --
      
      Updates the date and time for the Amplify app.
    - iamServiceRoleArn (string) --
      
      The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
    - environmentVariables (dict) --
      
      The environment variables for the Amplify app.
      - (string) --
        
        (string) --
    - defaultDomain (string) --
      
      The default domain for the Amplify app.
    - enableBranchAutoBuild (boolean) --
      
      Enables the auto-building of branches for the Amplify app.
    - enableBranchAutoDeletion (boolean) --
      
      Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
    - enableBasicAuth (boolean) --
      
      Enables basic authorization for the Amplify app's branches.
    - basicAuthCredentials (string) --
      
      The basic authorization credentials for branches for the Amplify app.
    - customRules (list) --
      
      Describes the custom redirect and rewrite rules for the Amplify app.
      - (dict) --
        
        Describes a custom rewrite or redirect rule.
        
        source (string) --
        
        The source pattern for a URL rewrite or redirect rule.
        
        target (string) --
        
        The target pattern for a URL rewrite or redirect rule.
        
        status (string) --
        
        The status code for a URL rewrite or redirect rule.
        
        condition (string) --
        
        The condition for a URL rewrite or redirect rule, such as a country code.
    - productionBranch (dict) --
      
      Describes the information about a production branch of the Amplify app.
      - lastDeployTime (datetime) --
        
        The last deploy time of the production branch.
      - status (string) --
        
        The status of the production branch.
      - thumbnailUrl (string) --
        
        The thumbnail URL for the production branch.
      - branchName (string) --
        
        The branch name for the production branch.
    - buildSpec (string) --
      
      Describes the content of the build specification (build spec) for the Amplify app.
    - enableAutoBranchCreation (boolean) --
      
      Enables automated branch creation for the Amplify app.
    - autoBranchCreationPatterns (list) --
      
      Describes the automated branch creation glob patterns for the Amplify app.
      - (string) --
    - autoBranchCreationConfig (dict) --
      
      Describes the automated branch creation configuration for the Amplify app.
      - stage (string) --
        
        Describes the current stage for the autocreated branch.
      - framework (string) --
        
        The framework for the autocreated branch.
      - enableAutoBuild (boolean) --
        
        Enables auto building for the autocreated branch.
      - environmentVariables (dict) --
        
        The environment variables for the autocreated branch.
        
        (string) --
        
        (string) --
      - basicAuthCredentials (string) --
        
        The basic authorization credentials for the autocreated branch.
      - enableBasicAuth (boolean) --
        
        Enables basic authorization for the autocreated branch.
      - buildSpec (string) --
        
        The build specification (build spec) for the autocreated branch.
      - enablePullRequestPreview (boolean) --
        
        Enables pull request preview for the autocreated branch.
      - pullRequestEnvironmentName (string) --
        
        The Amplify environment name for the pull request.
- nextToken (string) --
  
  A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.

ListDomainAssociations (updated)

Link ¶
Changes (response)

{'domainAssociations': {'autoSubDomainCreationPatterns': ['string'],
                        'autoSubDomainIAMRole': 'string'}}

Returns the domain associations for an Amplify app.

See also: AWS API Documentation

Request Syntax

client.list_domain_associations(
    appId='string',
    nextToken='string',
    maxResults=123
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type nextToken:

string

param nextToken:

A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.

type maxResults:

integer

param maxResults:

The maximum number of records to list in a single response.

rtype:

dict

returns:

Response Syntax

{
    'domainAssociations': [
        {
            'domainAssociationArn': 'string',
            'domainName': 'string',
            'enableAutoSubDomain': True|False,
            'autoSubDomainCreationPatterns': [
                'string',
            ],
            'autoSubDomainIAMRole': 'string',
            'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
            'statusReason': 'string',
            'certificateVerificationDNSRecord': 'string',
            'subDomains': [
                {
                    'subDomainSetting': {
                        'prefix': 'string',
                        'branchName': 'string'
                    },
                    'verified': True|False,
                    'dnsRecord': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

The result structure for the list domain association request.
- domainAssociations (list) --
  
  A list of domain associations.
  - (dict) --
    
    Describes a domain association that associates a custom domain with an Amplify app.
    - domainAssociationArn (string) --
      
      The Amazon Resource Name (ARN) for the domain association.
    - domainName (string) --
      
      The name of the domain.
    - enableAutoSubDomain (boolean) --
      
      Enables the automated creation of subdomains for branches.
    - autoSubDomainCreationPatterns (list) --
      
      Sets branch patterns for automatic subdomain creation.
      - (string) --
    - autoSubDomainIAMRole (string) --
      
      The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
    - domainStatus (string) --
      
      The current status of the domain association.
    - statusReason (string) --
      
      The reason for the current status of the domain association.
    - certificateVerificationDNSRecord (string) --
      
      The DNS record for certificate verification.
    - subDomains (list) --
      
      The subdomains for the domain association.
      - (dict) --
        
        The subdomain for the domain association.
        
        subDomainSetting (dict) --
        
        Describes the settings for the subdomain.
        
        prefix (string) --
        
        The prefix setting for the subdomain.
        
        branchName (string) --
        
        The branch name setting for the subdomain.
        
        verified (boolean) --
        
        The verified status of the subdomain
        
        dnsRecord (string) --
        
        The DNS record for the subdomain.
- nextToken (string) --
  
  A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.

UpdateApp (updated)

Link ¶
Changes (request, response)
Request

{'enableBranchAutoDeletion': 'boolean'}

Response

{'app': {'enableBranchAutoDeletion': 'boolean'}}

Updates an existing Amplify app.

See also: AWS API Documentation

Request Syntax

client.update_app(
    appId='string',
    name='string',
    description='string',
    platform='WEB',
    iamServiceRoleArn='string',
    environmentVariables={
        'string': 'string'
    },
    enableBranchAutoBuild=True|False,
    enableBranchAutoDeletion=True|False,
    enableBasicAuth=True|False,
    basicAuthCredentials='string',
    customRules=[
        {
            'source': 'string',
            'target': 'string',
            'status': 'string',
            'condition': 'string'
        },
    ],
    buildSpec='string',
    enableAutoBranchCreation=True|False,
    autoBranchCreationPatterns=[
        'string',
    ],
    autoBranchCreationConfig={
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
        'framework': 'string',
        'enableAutoBuild': True|False,
        'environmentVariables': {
            'string': 'string'
        },
        'basicAuthCredentials': 'string',
        'enableBasicAuth': True|False,
        'buildSpec': 'string',
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string'
    },
    repository='string',
    oauthToken='string',
    accessToken='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type name:

string

param name:

The name for an Amplify app.

type description:

string

param description:

The description for an Amplify app.

type platform:

string

param platform:

The platform for an Amplify app.

type iamServiceRoleArn:

string

param iamServiceRoleArn:

The AWS Identity and Access Management (IAM) service role for an Amplify app.

type environmentVariables:

dict

param environmentVariables:

The environment variables for an Amplify app.

(string) --
- (string) --

type enableBranchAutoBuild:

boolean

param enableBranchAutoBuild:

Enables branch auto-building for an Amplify app.

type enableBranchAutoDeletion:

boolean

param enableBranchAutoDeletion:

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

type enableBasicAuth:

boolean

param enableBasicAuth:

Enables basic authorization for an Amplify app.

type basicAuthCredentials:

string

param basicAuthCredentials:

The basic authorization credentials for an Amplify app.

type customRules:

list

param customRules:

The custom redirect and rewrite rules for an Amplify app.

(dict) --

Describes a custom rewrite or redirect rule.
- source (string) -- [REQUIRED]
  
  The source pattern for a URL rewrite or redirect rule.
- target (string) -- [REQUIRED]
  
  The target pattern for a URL rewrite or redirect rule.
- status (string) --
  
  The status code for a URL rewrite or redirect rule.
- condition (string) --
  
  The condition for a URL rewrite or redirect rule, such as a country code.

type buildSpec:

string

param buildSpec:

The build specification (build spec) for an Amplify app.

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for the Amplify app.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

Describes the automated branch creation glob patterns for the Amplify app.

(string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

The automated branch creation configuration for the Amplify app.

stage (string) --

Describes the current stage for the autocreated branch.
framework (string) --

The framework for the autocreated branch.
enableAutoBuild (boolean) --

Enables auto building for the autocreated branch.
environmentVariables (dict) --

The environment variables for the autocreated branch.
- (string) --
  - (string) --
basicAuthCredentials (string) --

The basic authorization credentials for the autocreated branch.
enableBasicAuth (boolean) --

Enables basic authorization for the autocreated branch.
buildSpec (string) --

The build specification (build spec) for the autocreated branch.
enablePullRequestPreview (boolean) --

Enables pull request preview for the autocreated branch.
pullRequestEnvironmentName (string) --

The Amplify environment name for the pull request.

type repository:

string

param repository:

The name of the repository for an Amplify app

type oauthToken:

string

param oauthToken:

The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

type accessToken:

string

param accessToken:

The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.

rtype:

dict

returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': True|False,
        'enableBranchAutoDeletion': True|False,
        'enableBasicAuth': True|False,
        'basicAuthCredentials': 'string',
        'customRules': [
            {
                'source': 'string',
                'target': 'string',
                'status': 'string',
                'condition': 'string'
            },
        ],
        'productionBranch': {
            'lastDeployTime': datetime(2015, 1, 1),
            'status': 'string',
            'thumbnailUrl': 'string',
            'branchName': 'string'
        },
        'buildSpec': 'string',
        'enableAutoBranchCreation': True|False,
        'autoBranchCreationPatterns': [
            'string',
        ],
        'autoBranchCreationConfig': {
            'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
            'framework': 'string',
            'enableAutoBuild': True|False,
            'environmentVariables': {
                'string': 'string'
            },
            'basicAuthCredentials': 'string',
            'enableBasicAuth': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        }
    }
}

Response Structure

(dict) --

The result structure for an Amplify app update request.
- app (dict) --
  
  Represents the updated Amplify app.
  - appId (string) --
    
    The unique ID of the Amplify app.
  - appArn (string) --
    
    The Amazon Resource Name (ARN) of the Amplify app.
  - name (string) --
    
    The name for the Amplify app.
  - tags (dict) --
    
    The tag for the Amplify app.
    - (string) --
      - (string) --
  - description (string) --
    
    The description for the Amplify app.
  - repository (string) --
    
    The repository for the Amplify app.
  - platform (string) --
    
    The platform for the Amplify app.
  - createTime (datetime) --
    
    Creates a date and time for the Amplify app.
  - updateTime (datetime) --
    
    Updates the date and time for the Amplify app.
  - iamServiceRoleArn (string) --
    
    The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
  - environmentVariables (dict) --
    
    The environment variables for the Amplify app.
    - (string) --
      - (string) --
  - defaultDomain (string) --
    
    The default domain for the Amplify app.
  - enableBranchAutoBuild (boolean) --
    
    Enables the auto-building of branches for the Amplify app.
  - enableBranchAutoDeletion (boolean) --
    
    Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
  - enableBasicAuth (boolean) --
    
    Enables basic authorization for the Amplify app's branches.
  - basicAuthCredentials (string) --
    
    The basic authorization credentials for branches for the Amplify app.
  - customRules (list) --
    
    Describes the custom redirect and rewrite rules for the Amplify app.
    - (dict) --
      
      Describes a custom rewrite or redirect rule.
      - source (string) --
        
        The source pattern for a URL rewrite or redirect rule.
      - target (string) --
        
        The target pattern for a URL rewrite or redirect rule.
      - status (string) --
        
        The status code for a URL rewrite or redirect rule.
      - condition (string) --
        
        The condition for a URL rewrite or redirect rule, such as a country code.
  - productionBranch (dict) --
    
    Describes the information about a production branch of the Amplify app.
    - lastDeployTime (datetime) --
      
      The last deploy time of the production branch.
    - status (string) --
      
      The status of the production branch.
    - thumbnailUrl (string) --
      
      The thumbnail URL for the production branch.
    - branchName (string) --
      
      The branch name for the production branch.
  - buildSpec (string) --
    
    Describes the content of the build specification (build spec) for the Amplify app.
  - enableAutoBranchCreation (boolean) --
    
    Enables automated branch creation for the Amplify app.
  - autoBranchCreationPatterns (list) --
    
    Describes the automated branch creation glob patterns for the Amplify app.
    - (string) --
  - autoBranchCreationConfig (dict) --
    
    Describes the automated branch creation configuration for the Amplify app.
    - stage (string) --
      
      Describes the current stage for the autocreated branch.
    - framework (string) --
      
      The framework for the autocreated branch.
    - enableAutoBuild (boolean) --
      
      Enables auto building for the autocreated branch.
    - environmentVariables (dict) --
      
      The environment variables for the autocreated branch.
      - (string) --
        
        (string) --
    - basicAuthCredentials (string) --
      
      The basic authorization credentials for the autocreated branch.
    - enableBasicAuth (boolean) --
      
      Enables basic authorization for the autocreated branch.
    - buildSpec (string) --
      
      The build specification (build spec) for the autocreated branch.
    - enablePullRequestPreview (boolean) --
      
      Enables pull request preview for the autocreated branch.
    - pullRequestEnvironmentName (string) --
      
      The Amplify environment name for the pull request.

UpdateDomainAssociation (updated)

Link ¶
Changes (request, response)
Request

{'autoSubDomainCreationPatterns': ['string'], 'autoSubDomainIAMRole': 'string'}

Response

{'domainAssociation': {'autoSubDomainCreationPatterns': ['string'],
                       'autoSubDomainIAMRole': 'string'}}

Creates a new domain association for an Amplify app.

See also: AWS API Documentation

Request Syntax

client.update_domain_association(
    appId='string',
    domainName='string',
    enableAutoSubDomain=True|False,
    subDomainSettings=[
        {
            'prefix': 'string',
            'branchName': 'string'
        },
    ],
    autoSubDomainCreationPatterns=[
        'string',
    ],
    autoSubDomainIAMRole='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type domainName:

string

param domainName:

[REQUIRED]

The name of the domain.

type enableAutoSubDomain:

boolean

param enableAutoSubDomain:

Enables the automated creation of subdomains for branches.

type subDomainSettings:

list

param subDomainSettings:

[REQUIRED]

Describes the settings for the subdomain.

(dict) --

Describes the settings for the subdomain.
- prefix (string) -- [REQUIRED]
  
  The prefix setting for the subdomain.
- branchName (string) -- [REQUIRED]
  
  The branch name setting for the subdomain.

type autoSubDomainCreationPatterns:

list

param autoSubDomainCreationPatterns:

Sets the branch patterns for automatic subdomain creation.

(string) --

type autoSubDomainIAMRole:

string

param autoSubDomainIAMRole:

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

rtype:

dict

returns:

Response Syntax

{
    'domainAssociation': {
        'domainAssociationArn': 'string',
        'domainName': 'string',
        'enableAutoSubDomain': True|False,
        'autoSubDomainCreationPatterns': [
            'string',
        ],
        'autoSubDomainIAMRole': 'string',
        'domainStatus': 'PENDING_VERIFICATION'|'IN_PROGRESS'|'AVAILABLE'|'PENDING_DEPLOYMENT'|'FAILED'|'CREATING'|'REQUESTING_CERTIFICATE'|'UPDATING',
        'statusReason': 'string',
        'certificateVerificationDNSRecord': 'string',
        'subDomains': [
            {
                'subDomainSetting': {
                    'prefix': 'string',
                    'branchName': 'string'
                },
                'verified': True|False,
                'dnsRecord': 'string'
            },
        ]
    }
}

Response Structure

(dict) --

The result structure for the update domain association request.
- domainAssociation (dict) --
  
  Describes a domain association, which associates a custom domain with an Amplify app.
  - domainAssociationArn (string) --
    
    The Amazon Resource Name (ARN) for the domain association.
  - domainName (string) --
    
    The name of the domain.
  - enableAutoSubDomain (boolean) --
    
    Enables the automated creation of subdomains for branches.
  - autoSubDomainCreationPatterns (list) --
    
    Sets branch patterns for automatic subdomain creation.
    - (string) --
  - autoSubDomainIAMRole (string) --
    
    The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
  - domainStatus (string) --
    
    The current status of the domain association.
  - statusReason (string) --
    
    The reason for the current status of the domain association.
  - certificateVerificationDNSRecord (string) --
    
    The DNS record for certificate verification.
  - subDomains (list) --
    
    The subdomains for the domain association.
    - (dict) --
      
      The subdomain for the domain association.
      - subDomainSetting (dict) --
        
        Describes the settings for the subdomain.
        
        prefix (string) --
        
        The prefix setting for the subdomain.
        
        branchName (string) --
        
        The branch name setting for the subdomain.
      - verified (boolean) --
        
        The verified status of the subdomain
      - dnsRecord (string) --
        
        The DNS record for the subdomain.