AWS Amplify

{'platform': {'WEB_DYNAMIC'}}

{'app': {'platform': {'WEB_DYNAMIC'},
         'repositoryCloneMethod': 'SSH | TOKEN | SIGV4'}}

Creates a new Amplify app.

See also: AWS API Documentation

Request Syntax

client.create_app(
    name='string',
    description='string',
    repository='string',
    platform='WEB'|'WEB_DYNAMIC',
    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',
    customHeaders='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,
        'enablePerformanceMode': True|False,
        'buildSpec': 'string',
        'enablePullRequestPreview': True|False,
        'pullRequestEnvironmentName': 'string'
    }
)

type name:

string

param name:

[REQUIRED]

The name for an 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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.

    200

    Represents a 200 rewrite rule.

    301

    Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

    302

    Represents a 302 temporary redirect rule.

    404

    Represents a 404 redirect rule.

    404-200

    Represents a 404 rewrite 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 customHeaders:

string

param customHeaders:

The custom HTTP headers for an Amplify app.

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for an Amplify app.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

The automated branch creation glob patterns for an Amplify app.

• (string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

The automated branch creation configuration for an 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. You must base64-encode the authorization credentials and provide them in the format user:password.

• enableBasicAuth (boolean) --

  Enables basic authorization for the autocreated branch.

• enablePerformanceMode (boolean) --

  Enables performance mode for the branch.

  Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

• buildSpec (string) --

  The build specification (build spec) for the autocreated branch.

• enablePullRequestPreview (boolean) --

  Enables pull request previews 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'|'WEB_DYNAMIC',
        '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',
        'customHeaders': '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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        },
        'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
    }
}

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 Git 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 disconnect 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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

          200

          Represents a 200 rewrite rule.

          301

          Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

          302

          Represents a 302 temporary redirect rule.

          404

          Represents a 404 redirect rule.

          404-200

          Represents a 404 rewrite 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.

    • customHeaders (string) --

      Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.

      • enableBasicAuth (boolean) --

        Enables basic authorization for the autocreated branch.

      • enablePerformanceMode (boolean) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • buildSpec (string) --

        The build specification (build spec) for the autocreated branch.

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the autocreated branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

    • repositoryCloneMethod (string) --

      The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.

{'app': {'platform': {'WEB_DYNAMIC'},
         'repositoryCloneMethod': 'SSH | TOKEN | SIGV4'}}

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'|'WEB_DYNAMIC',
        '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',
        'customHeaders': '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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        },
        'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
    }
}

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 Git 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 disconnect 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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

          200

          Represents a 200 rewrite rule.

          301

          Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

          302

          Represents a 302 temporary redirect rule.

          404

          Represents a 404 redirect rule.

          404-200

          Represents a 404 rewrite 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.

    • customHeaders (string) --

      Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.

      • enableBasicAuth (boolean) --

        Enables basic authorization for the autocreated branch.

      • enablePerformanceMode (boolean) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • buildSpec (string) --

        The build specification (build spec) for the autocreated branch.

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the autocreated branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

    • repositoryCloneMethod (string) --

      The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.

{'app': {'platform': {'WEB_DYNAMIC'},
         'repositoryCloneMethod': 'SSH | TOKEN | SIGV4'}}

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'|'WEB_DYNAMIC',
        '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',
        'customHeaders': '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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        },
        'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
    }
}

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 Git 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 disconnect 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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

          200

          Represents a 200 rewrite rule.

          301

          Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

          302

          Represents a 302 temporary redirect rule.

          404

          Represents a 404 redirect rule.

          404-200

          Represents a 404 rewrite 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.

    • customHeaders (string) --

      Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.

      • enableBasicAuth (boolean) --

        Enables basic authorization for the autocreated branch.

      • enablePerformanceMode (boolean) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • buildSpec (string) --

        The build specification (build spec) for the autocreated branch.

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the autocreated branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

    • repositoryCloneMethod (string) --

      The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.

{'apps': {'platform': {'WEB_DYNAMIC'},
          'repositoryCloneMethod': 'SSH | TOKEN | SIGV4'}}

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'|'WEB_DYNAMIC',
            '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',
            'customHeaders': '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,
                'enablePerformanceMode': True|False,
                'buildSpec': 'string',
                'enablePullRequestPreview': True|False,
                'pullRequestEnvironmentName': 'string'
            },
            'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
        },
    ],
    '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 Git 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 disconnect 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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

            200

            Represents a 200 rewrite rule.

            301

            Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

            302

            Represents a 302 temporary redirect rule.

            404

            Represents a 404 redirect rule.

            404-200

            Represents a 404 rewrite 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.

      • customHeaders (string) --

        Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.

        • enableBasicAuth (boolean) --

          Enables basic authorization for the autocreated branch.

        • enablePerformanceMode (boolean) --

          Enables performance mode for the branch.

          Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

        • buildSpec (string) --

          The build specification (build spec) for the autocreated branch.

        • enablePullRequestPreview (boolean) --

          Enables pull request previews for the autocreated branch.

        • pullRequestEnvironmentName (string) --

          The Amplify environment name for the pull request.

      • repositoryCloneMethod (string) --

        The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.

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

{'platform': {'WEB_DYNAMIC'}}

{'app': {'platform': {'WEB_DYNAMIC'},
         'repositoryCloneMethod': 'SSH | TOKEN | SIGV4'}}

Updates an existing Amplify app.

See also: AWS API Documentation

Request Syntax

client.update_app(
    appId='string',
    name='string',
    description='string',
    platform='WEB'|'WEB_DYNAMIC',
    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',
    customHeaders='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,
        'enablePerformanceMode': 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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.

    200

    Represents a 200 rewrite rule.

    301

    Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

    302

    Represents a 302 temporary redirect rule.

    404

    Represents a 404 redirect rule.

    404-200

    Represents a 404 rewrite 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 customHeaders:

string

param customHeaders:

The custom HTTP headers for an Amplify app.

type enableAutoBranchCreation:

boolean

param enableAutoBranchCreation:

Enables automated branch creation for an Amplify app.

type autoBranchCreationPatterns:

list

param autoBranchCreationPatterns:

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

• (string) --

type autoBranchCreationConfig:

dict

param autoBranchCreationConfig:

The automated branch creation configuration for an 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. You must base64-encode the authorization credentials and provide them in the format user:password.

• enableBasicAuth (boolean) --

  Enables basic authorization for the autocreated branch.

• enablePerformanceMode (boolean) --

  Enables performance mode for the branch.

  Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

• buildSpec (string) --

  The build specification (build spec) for the autocreated branch.

• enablePullRequestPreview (boolean) --

  Enables pull request previews 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'|'WEB_DYNAMIC',
        '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',
        'customHeaders': '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,
            'enablePerformanceMode': True|False,
            'buildSpec': 'string',
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string'
        },
        'repositoryCloneMethod': 'SSH'|'TOKEN'|'SIGV4'
    }
}

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 Git 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 disconnect 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. You must base64-encode the authorization credentials and provide them in the format user:password.

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

          200

          Represents a 200 rewrite rule.

          301

          Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.

          302

          Represents a 302 temporary redirect rule.

          404

          Represents a 404 redirect rule.

          404-200

          Represents a 404 rewrite 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.

    • customHeaders (string) --

      Describes the custom HTTP headers 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. You must base64-encode the authorization credentials and provide them in the format user:password.

      • enableBasicAuth (boolean) --

        Enables basic authorization for the autocreated branch.

      • enablePerformanceMode (boolean) --

        Enables performance mode for the branch.

        Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

      • buildSpec (string) --

        The build specification (build spec) for the autocreated branch.

      • enablePullRequestPreview (boolean) --

        Enables pull request previews for the autocreated branch.

      • pullRequestEnvironmentName (string) --

        The Amplify environment name for the pull request.

    • repositoryCloneMethod (string) --

      The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.