Amplify / Client / get_app

get_app

Amplify.Client.get_app(**kwargs)

Returns an existing Amplify app specified by an app ID.

See also: AWS API Documentation

Request Syntax

response = client.get_app(
    appId='string'
)

Parameters:

appId (string) –

[REQUIRED]

The unique ID for an Amplify app.

Return type:

dict

Returns:

Response Syntax

{
    'app': {
        'appId': 'string',
        'appArn': 'string',
        'name': 'string',
        'tags': {
            'string': 'string'
        },
        'description': 'string',
        'repository': 'string',
        'platform': 'WEB'|'WEB_DYNAMIC'|'WEB_COMPUTE',
        '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. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting’s original SSR support only, set the platform type to WEB_DYNAMIC.

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

      For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

      • (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) –

      Note

      This is for internal use.

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

Exceptions

• Amplify.Client.exceptions.BadRequestException

• Amplify.Client.exceptions.NotFoundException

• Amplify.Client.exceptions.UnauthorizedException

• Amplify.Client.exceptions.InternalFailureException