Amplify / Client / list_branches

list_branches

Amplify.Client.list_branches(**kwargs)

Lists the branches of an Amplify app.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• appId (string) –

  [REQUIRED]

  The unique ID for an Amplify app.

• nextToken (string) – A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.

• maxResults (integer) – The maximum number of records to list in a single response.

Return type:

dict

Returns:

Response Syntax

{
    'branches': [
        {
            'branchArn': 'string',
            'branchName': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            },
            'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL'|'PULL_REQUEST',
            'displayName': 'string',
            'enableNotification': True|False,
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'environmentVariables': {
                'string': 'string'
            },
            'enableAutoBuild': True|False,
            'customDomains': [
                'string',
            ],
            'framework': 'string',
            'activeJobId': 'string',
            'totalNumberOfJobs': 'string',
            'enableBasicAuth': True|False,
            'enablePerformanceMode': True|False,
            'thumbnailUrl': 'string',
            'basicAuthCredentials': 'string',
            'buildSpec': 'string',
            'ttl': 'string',
            'associatedResources': [
                'string',
            ],
            'enablePullRequestPreview': True|False,
            'pullRequestEnvironmentName': 'string',
            'destinationBranch': 'string',
            'sourceBranch': 'string',
            'backendEnvironmentArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  The result structure for the list branches request.

  • branches (list) –

    A list of branches for an Amplify app.

    • (dict) –

      The branch for an Amplify app, which maps to a third-party repository branch.

      • branchArn (string) –

        The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

      • branchName (string) –

        The name for the branch that is part of an Amplify app.

      • description (string) –

        The description for the branch that is part of an Amplify app.

      • tags (dict) –

        The tag for the branch of an Amplify app.

        • (string) –

          • (string) –

      • stage (string) –

        The current stage for the branch that is part of an Amplify app.

      • displayName (string) –

        The display name for the branch. This is used as the default domain prefix.

      • enableNotification (boolean) –

        Enables notifications for a branch that is part of an Amplify app.

      • createTime (datetime) –

        The creation date and time for a branch that is part of an Amplify app.

      • updateTime (datetime) –

        The last updated date and time for a branch that is part of an Amplify app.

      • environmentVariables (dict) –

        The environment variables specific to a branch of an Amplify app.

        • (string) –

          • (string) –

      • enableAutoBuild (boolean) –

        Enables auto-building on push for a branch of an Amplify app.

      • customDomains (list) –

        The custom domains for a branch of an Amplify app.

        • (string) –

      • framework (string) –

        The framework for a branch of an Amplify app.

      • activeJobId (string) –

        The ID of the active job for a branch of an Amplify app.

      • totalNumberOfJobs (string) –

        The total number of jobs that are part of an Amplify app.

      • enableBasicAuth (boolean) –

        Enables basic authorization for a branch of an Amplify app.

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

      • thumbnailUrl (string) –

        The thumbnail URL for the branch of an Amplify app.

      • basicAuthCredentials (string) –

        The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

      • buildSpec (string) –

        The build specification (build spec) content for the branch of an Amplify app.

      • ttl (string) –

        The content Time to Live (TTL) for the website in seconds.

      • associatedResources (list) –

        A list of custom resources that are linked to this branch.

        • (string) –

      • enablePullRequestPreview (boolean) –

        Enables pull request previews for the branch.

      • pullRequestEnvironmentName (string) –

        The Amplify environment name for the pull request.

      • destinationBranch (string) –

        The destination branch if the branch is a pull request branch.

      • sourceBranch (string) –

        The source branch if the branch is a pull request branch.

      • backendEnvironmentArn (string) –

        The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

  • nextToken (string) –

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

Exceptions

• Amplify.Client.exceptions.BadRequestException

• Amplify.Client.exceptions.UnauthorizedException

• Amplify.Client.exceptions.InternalFailureException