Amplify

Table of Contents

Client

class Amplify.Client

A low-level client representing AWS Amplify:

client = session.create_client('amplify')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_app(**kwargs)

Creates a new Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.create_app(
    name='string',
    description='string',
    repository='string',
    platform='IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
    iamServiceRoleArn='string',
    oauthToken='string',
    environmentVariables={
        'string': 'string'
    },
    enableBranchAutoBuild=True|False,
    enableBasicAuth=True|False,
    basicAuthCredentials='string',
    customRules=[
        {
            'source': 'string',
            'target': 'string',
            'status': 'string',
            'condition': 'string'
        },
    ],
    tags={
        'string': 'string'
    },
    buildSpec='string'
)
Parameters
  • name (string) --

    [REQUIRED]

    Name for the Amplify App

  • description (string) -- Description for an Amplify App
  • repository (string) --

    [REQUIRED]

    Repository for an Amplify App

  • platform (string) --

    [REQUIRED]

    Platform / framework for an Amplify App

  • iamServiceRoleArn (string) -- AWS IAM service role for an Amplify App
  • oauthToken (string) --

    [REQUIRED]

    OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

  • environmentVariables (dict) --

    Environment variables map for an Amplify App.

    • (string) --
      • (string) --
  • enableBranchAutoBuild (boolean) -- Enable the auto building of branches for an Amplify App.
  • enableBasicAuth (boolean) -- Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
  • basicAuthCredentials (string) -- Credentials for Basic Authorization for an Amplify App.
  • customRules (list) --

    Custom rewrite / redirect rules for an Amplify App.

    • (dict) --

      Custom rewrite / 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, e.g. country code.

  • tags (dict) --

    Tag for an Amplify App

    • (string) --
      • (string) --
  • buildSpec (string) -- BuildSpec 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': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': 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'
    }
}

Response Structure

  • (dict) --

    • app (dict) --

      Amplify App represents different branches of a repository for building, deploying, and hosting.

      • appId (string) --

        Unique Id for the Amplify App.

      • appArn (string) --

        ARN for the Amplify App.

      • name (string) --

        Name for the Amplify App.

      • tags (dict) --

        Tag for Amplify App.

        • (string) --
          • (string) --
      • description (string) --

        Description for the Amplify App.

      • repository (string) --

        Repository for the Amplify App.

      • platform (string) --

        Platform for the Amplify App.

      • createTime (datetime) --

        Create date / time for the Amplify App.

      • updateTime (datetime) --

        Update date / time for the Amplify App.

      • iamServiceRoleArn (string) --

        IAM service role ARN for the Amplify App.

      • environmentVariables (dict) --

        Environment Variables for the Amplify App.

        • (string) --
          • (string) --
      • defaultDomain (string) --

        Default domain for the Amplify App.

      • enableBranchAutoBuild (boolean) --

        Enables auto-building of branches for the Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for branches for the Amplify App.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for branches for the Amplify App.

      • customRules (list) --

        Custom redirect / rewrite rules for the Amplify App.

        • (dict) --

          Custom rewrite / 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, e.g. country code.

      • productionBranch (dict) --

        Structure with Production Branch information.

        • lastDeployTime (datetime) --

          Last Deploy Time of Production Branch.

        • status (string) --

          Status of Production Branch.

        • thumbnailUrl (string) --

          Thumbnail Url for Production Branch.

        • branchName (string) --

          Branch Name for Production Branch.

      • buildSpec (string) --

        BuildSpec content for Amplify App.

create_branch(**kwargs)

Creates a new Branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.create_branch(
    appId='string',
    branchName='string',
    description='string',
    stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
    framework='string',
    enableNotification=True|False,
    enableAutoBuild=True|False,
    environmentVariables={
        'string': 'string'
    },
    basicAuthCredentials='string',
    enableBasicAuth=True|False,
    tags={
        'string': 'string'
    },
    buildSpec='string',
    ttl='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch.

  • description (string) -- Description for the branch.
  • stage (string) -- Stage for the branch.
  • framework (string) -- Framework for the branch.
  • enableNotification (boolean) -- Enables notifications for the branch.
  • enableAutoBuild (boolean) -- Enables auto building for the branch.
  • environmentVariables (dict) --

    Environment Variables for the branch.

    • (string) --
      • (string) --
  • basicAuthCredentials (string) -- Basic Authorization credentials for the branch.
  • enableBasicAuth (boolean) -- Enables Basic Auth for the branch.
  • tags (dict) --

    Tag for the branch.

    • (string) --
      • (string) --
  • buildSpec (string) -- BuildSpec for the branch.
  • ttl (string) -- The content TTL for the website in seconds.
Return type

dict

Returns

Response Syntax

{
    'branch': {
        'branchArn': 'string',
        'branchName': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
        '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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string'
    }
}

Response Structure

  • (dict) --

    Result structure for create branch request.

    • branch (dict) --

      Branch structure for an Amplify App.

      • branchArn (string) --

        ARN for a branch, part of an Amplify App.

      • branchName (string) --

        Name for a branch, part of an Amplify App.

      • description (string) --

        Description for a branch, part of an Amplify App.

      • tags (dict) --

        Tag for branch for Amplify App.

        • (string) --
          • (string) --
      • stage (string) --

        Stage for a branch, part of an Amplify App.

      • displayName (string) --

        Display name for a branch, part of an Amplify App.

      • enableNotification (boolean) --

        Enables notifications for a branch, part of an Amplify App.

      • createTime (datetime) --

        Creation date and time for a branch, part of an Amplify App.

      • updateTime (datetime) --

        Last updated date and time for a branch, part of an Amplify App.

      • environmentVariables (dict) --

        Environment Variables specific to a branch, part of an Amplify App.

        • (string) --
          • (string) --
      • enableAutoBuild (boolean) --

        Enables auto-building on push for a branch, part of an Amplify App.

      • customDomains (list) --

        Custom domains for a branch, part of an Amplify App.

        • (string) --
      • framework (string) --

        Framework for a branch, part of an Amplify App.

      • activeJobId (string) --

        Id of the active job for a branch, part of an Amplify App.

      • totalNumberOfJobs (string) --

        Total number of Jobs part of an Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for a branch, part of an Amplify App.

      • thumbnailUrl (string) --

        Thumbnail Url for the branch.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for a branch, part of an Amplify App.

      • buildSpec (string) --

        BuildSpec content for branch for Amplify App.

      • ttl (string) --

        The content TTL for the website in seconds.

create_domain_association(**kwargs)

Create a new DomainAssociation on an App

See also: AWS API Documentation

Request Syntax

response = client.create_domain_association(
    appId='string',
    domainName='string',
    enableAutoSubDomain=True|False,
    subDomainSettings=[
        {
            'prefix': 'string',
            'branchName': 'string'
        },
    ]
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • domainName (string) --

    [REQUIRED]

    Domain name for the Domain Association.

  • enableAutoSubDomain (boolean) -- Enables automated creation of Subdomains for branches.
  • subDomainSettings (list) --

    [REQUIRED]

    Setting structure for the Subdomain.

    • (dict) --

      Setting for the Subdomain.

      • prefix (string) -- [REQUIRED]

        Prefix setting for the Subdomain.

      • branchName (string) -- [REQUIRED]

        Branch name setting for the Subdomain.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Result structure for the create Domain Association request.

    • domainAssociation (dict) --

      Domain Association structure.

      • domainAssociationArn (string) --

        ARN for the Domain Association.

      • domainName (string) --

        Name of the domain.

      • enableAutoSubDomain (boolean) --

        Enables automated creation of Subdomains for branches.

      • domainStatus (string) --

        Status fo the Domain Association.

      • statusReason (string) --

        Reason for the current status of the Domain Association.

      • certificateVerificationDNSRecord (string) --

        DNS Record for certificate verification.

      • subDomains (list) --

        Subdomains for the Domain Association.

        • (dict) --

          Subdomain for the Domain Association.

          • subDomainSetting (dict) --

            Setting structure for the Subdomain.

            • prefix (string) --

              Prefix setting for the Subdomain.

            • branchName (string) --

              Branch name setting for the Subdomain.

          • verified (boolean) --

            Verified status of the Subdomain

          • dnsRecord (string) --

            DNS record for the Subdomain.

delete_app(**kwargs)

Delete an existing Amplify App by appId.

See also: AWS API Documentation

Request Syntax

response = client.delete_app(
    appId='string'
)
Parameters
appId (string) --

[REQUIRED]

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': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': 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'
    }
}

Response Structure

  • (dict) --

    Result structure for an Amplify App delete request.

    • app (dict) --

      Amplify App represents different branches of a repository for building, deploying, and hosting.

      • appId (string) --

        Unique Id for the Amplify App.

      • appArn (string) --

        ARN for the Amplify App.

      • name (string) --

        Name for the Amplify App.

      • tags (dict) --

        Tag for Amplify App.

        • (string) --
          • (string) --
      • description (string) --

        Description for the Amplify App.

      • repository (string) --

        Repository for the Amplify App.

      • platform (string) --

        Platform for the Amplify App.

      • createTime (datetime) --

        Create date / time for the Amplify App.

      • updateTime (datetime) --

        Update date / time for the Amplify App.

      • iamServiceRoleArn (string) --

        IAM service role ARN for the Amplify App.

      • environmentVariables (dict) --

        Environment Variables for the Amplify App.

        • (string) --
          • (string) --
      • defaultDomain (string) --

        Default domain for the Amplify App.

      • enableBranchAutoBuild (boolean) --

        Enables auto-building of branches for the Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for branches for the Amplify App.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for branches for the Amplify App.

      • customRules (list) --

        Custom redirect / rewrite rules for the Amplify App.

        • (dict) --

          Custom rewrite / 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, e.g. country code.

      • productionBranch (dict) --

        Structure with Production Branch information.

        • lastDeployTime (datetime) --

          Last Deploy Time of Production Branch.

        • status (string) --

          Status of Production Branch.

        • thumbnailUrl (string) --

          Thumbnail Url for Production Branch.

        • branchName (string) --

          Branch Name for Production Branch.

      • buildSpec (string) --

        BuildSpec content for Amplify App.

delete_branch(**kwargs)

Deletes a branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.delete_branch(
    appId='string',
    branchName='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch.

Return type

dict

Returns

Response Syntax

{
    'branch': {
        'branchArn': 'string',
        'branchName': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
        '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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string'
    }
}

Response Structure

  • (dict) --

    Result structure for delete branch request.

    • branch (dict) --

      Branch structure for an Amplify App.

      • branchArn (string) --

        ARN for a branch, part of an Amplify App.

      • branchName (string) --

        Name for a branch, part of an Amplify App.

      • description (string) --

        Description for a branch, part of an Amplify App.

      • tags (dict) --

        Tag for branch for Amplify App.

        • (string) --
          • (string) --
      • stage (string) --

        Stage for a branch, part of an Amplify App.

      • displayName (string) --

        Display name for a branch, part of an Amplify App.

      • enableNotification (boolean) --

        Enables notifications for a branch, part of an Amplify App.

      • createTime (datetime) --

        Creation date and time for a branch, part of an Amplify App.

      • updateTime (datetime) --

        Last updated date and time for a branch, part of an Amplify App.

      • environmentVariables (dict) --

        Environment Variables specific to a branch, part of an Amplify App.

        • (string) --
          • (string) --
      • enableAutoBuild (boolean) --

        Enables auto-building on push for a branch, part of an Amplify App.

      • customDomains (list) --

        Custom domains for a branch, part of an Amplify App.

        • (string) --
      • framework (string) --

        Framework for a branch, part of an Amplify App.

      • activeJobId (string) --

        Id of the active job for a branch, part of an Amplify App.

      • totalNumberOfJobs (string) --

        Total number of Jobs part of an Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for a branch, part of an Amplify App.

      • thumbnailUrl (string) --

        Thumbnail Url for the branch.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for a branch, part of an Amplify App.

      • buildSpec (string) --

        BuildSpec content for branch for Amplify App.

      • ttl (string) --

        The content TTL for the website in seconds.

delete_domain_association(**kwargs)

Deletes a DomainAssociation.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain_association(
    appId='string',
    domainName='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • domainName (string) --

    [REQUIRED]

    Name of the domain.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • domainAssociation (dict) --

      Structure for Domain Association, which associates a custom domain with an Amplify App.

      • domainAssociationArn (string) --

        ARN for the Domain Association.

      • domainName (string) --

        Name of the domain.

      • enableAutoSubDomain (boolean) --

        Enables automated creation of Subdomains for branches.

      • domainStatus (string) --

        Status fo the Domain Association.

      • statusReason (string) --

        Reason for the current status of the Domain Association.

      • certificateVerificationDNSRecord (string) --

        DNS Record for certificate verification.

      • subDomains (list) --

        Subdomains for the Domain Association.

        • (dict) --

          Subdomain for the Domain Association.

          • subDomainSetting (dict) --

            Setting structure for the Subdomain.

            • prefix (string) --

              Prefix setting for the Subdomain.

            • branchName (string) --

              Branch name setting for the Subdomain.

          • verified (boolean) --

            Verified status of the Subdomain

          • dnsRecord (string) --

            DNS record for the Subdomain.

delete_job(**kwargs)

Delete a job, for an Amplify branch, part of Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.delete_job(
    appId='string',
    branchName='string',
    jobId='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch, for the Job.

  • jobId (string) --

    [REQUIRED]

    Unique Id for the Job.

Return type

dict

Returns

Response Syntax

{
    'jobSummary': {
        'jobArn': 'string',
        'jobId': 'string',
        'commitId': 'string',
        'commitMessage': 'string',
        'commitTime': datetime(2015, 1, 1),
        'startTime': datetime(2015, 1, 1),
        'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
        'endTime': datetime(2015, 1, 1),
        'jobType': 'RELEASE'|'RETRY'|'WEB_HOOK'
    }
}

Response Structure

  • (dict) --

    Result structure for the delete job request.

    • jobSummary (dict) --

      Structure for the summary of a Job.

      • jobArn (string) --

        Arn for the Job.

      • jobId (string) --

        Unique Id for the Job.

      • commitId (string) --

        Commit Id from 3rd party repository provider for the Job.

      • commitMessage (string) --

        Commit message from 3rd party repository provider for the Job.

      • commitTime (datetime) --

        Commit date / time for the Job.

      • startTime (datetime) --

        Start date / time for the Job.

      • status (string) --

        Status for the Job.

      • endTime (datetime) --

        End date / time for the Job.

      • jobType (string) --

        Type for the Job.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_app(**kwargs)

Retrieves an existing Amplify App by appId.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

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': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': 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'
    }
}

Response Structure

  • (dict) --
    • app (dict) --

      Amplify App represents different branches of a repository for building, deploying, and hosting.

      • appId (string) --

        Unique Id for the Amplify App.

      • appArn (string) --

        ARN for the Amplify App.

      • name (string) --

        Name for the Amplify App.

      • tags (dict) --

        Tag for Amplify App.

        • (string) --
          • (string) --
      • description (string) --

        Description for the Amplify App.

      • repository (string) --

        Repository for the Amplify App.

      • platform (string) --

        Platform for the Amplify App.

      • createTime (datetime) --

        Create date / time for the Amplify App.

      • updateTime (datetime) --

        Update date / time for the Amplify App.

      • iamServiceRoleArn (string) --

        IAM service role ARN for the Amplify App.

      • environmentVariables (dict) --

        Environment Variables for the Amplify App.

        • (string) --
          • (string) --
      • defaultDomain (string) --

        Default domain for the Amplify App.

      • enableBranchAutoBuild (boolean) --

        Enables auto-building of branches for the Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for branches for the Amplify App.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for branches for the Amplify App.

      • customRules (list) --

        Custom redirect / rewrite rules for the Amplify App.

        • (dict) --

          Custom rewrite / 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, e.g. country code.

      • productionBranch (dict) --

        Structure with Production Branch information.

        • lastDeployTime (datetime) --

          Last Deploy Time of Production Branch.

        • status (string) --

          Status of Production Branch.

        • thumbnailUrl (string) --

          Thumbnail Url for Production Branch.

        • branchName (string) --

          Branch Name for Production Branch.

      • buildSpec (string) --

        BuildSpec content for Amplify App.

get_branch(**kwargs)

Retrieves a branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.get_branch(
    appId='string',
    branchName='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch.

Return type

dict

Returns

Response Syntax

{
    'branch': {
        'branchArn': 'string',
        'branchName': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
        '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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string'
    }
}

Response Structure

  • (dict) --

    • branch (dict) --

      Branch for an Amplify App, which maps to a 3rd party repository branch.

      • branchArn (string) --

        ARN for a branch, part of an Amplify App.

      • branchName (string) --

        Name for a branch, part of an Amplify App.

      • description (string) --

        Description for a branch, part of an Amplify App.

      • tags (dict) --

        Tag for branch for Amplify App.

        • (string) --
          • (string) --
      • stage (string) --

        Stage for a branch, part of an Amplify App.

      • displayName (string) --

        Display name for a branch, part of an Amplify App.

      • enableNotification (boolean) --

        Enables notifications for a branch, part of an Amplify App.

      • createTime (datetime) --

        Creation date and time for a branch, part of an Amplify App.

      • updateTime (datetime) --

        Last updated date and time for a branch, part of an Amplify App.

      • environmentVariables (dict) --

        Environment Variables specific to a branch, part of an Amplify App.

        • (string) --
          • (string) --
      • enableAutoBuild (boolean) --

        Enables auto-building on push for a branch, part of an Amplify App.

      • customDomains (list) --

        Custom domains for a branch, part of an Amplify App.

        • (string) --
      • framework (string) --

        Framework for a branch, part of an Amplify App.

      • activeJobId (string) --

        Id of the active job for a branch, part of an Amplify App.

      • totalNumberOfJobs (string) --

        Total number of Jobs part of an Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for a branch, part of an Amplify App.

      • thumbnailUrl (string) --

        Thumbnail Url for the branch.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for a branch, part of an Amplify App.

      • buildSpec (string) --

        BuildSpec content for branch for Amplify App.

      • ttl (string) --

        The content TTL for the website in seconds.

get_domain_association(**kwargs)

Retrieves domain info that corresponds to an appId and domainName.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_association(
    appId='string',
    domainName='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • domainName (string) --

    [REQUIRED]

    Name of the domain.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Result structure for the get Domain Association request.

    • domainAssociation (dict) --

      Domain Association structure.

      • domainAssociationArn (string) --

        ARN for the Domain Association.

      • domainName (string) --

        Name of the domain.

      • enableAutoSubDomain (boolean) --

        Enables automated creation of Subdomains for branches.

      • domainStatus (string) --

        Status fo the Domain Association.

      • statusReason (string) --

        Reason for the current status of the Domain Association.

      • certificateVerificationDNSRecord (string) --

        DNS Record for certificate verification.

      • subDomains (list) --

        Subdomains for the Domain Association.

        • (dict) --

          Subdomain for the Domain Association.

          • subDomainSetting (dict) --

            Setting structure for the Subdomain.

            • prefix (string) --

              Prefix setting for the Subdomain.

            • branchName (string) --

              Branch name setting for the Subdomain.

          • verified (boolean) --

            Verified status of the Subdomain

          • dnsRecord (string) --

            DNS record for the Subdomain.

get_job(**kwargs)

Get a job for a branch, part of an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.get_job(
    appId='string',
    branchName='string',
    jobId='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch, for the Job.

  • jobId (string) --

    [REQUIRED]

    Unique Id for the Job.

Return type

dict

Returns

Response Syntax

{
    'job': {
        'summary': {
            'jobArn': 'string',
            'jobId': 'string',
            'commitId': 'string',
            'commitMessage': 'string',
            'commitTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
            'endTime': datetime(2015, 1, 1),
            'jobType': 'RELEASE'|'RETRY'|'WEB_HOOK'
        },
        'steps': [
            {
                'stepName': 'string',
                'startTime': datetime(2015, 1, 1),
                'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
                'endTime': datetime(2015, 1, 1),
                'logUrl': 'string',
                'artifactsUrl': 'string',
                'screenshots': {
                    'string': 'string'
                }
            },
        ]
    }
}

Response Structure

  • (dict) --

    • job (dict) --

      Structure for an execution job for an Amplify App.

      • summary (dict) --

        Summary for an execution job for an Amplify App.

        • jobArn (string) --

          Arn for the Job.

        • jobId (string) --

          Unique Id for the Job.

        • commitId (string) --

          Commit Id from 3rd party repository provider for the Job.

        • commitMessage (string) --

          Commit message from 3rd party repository provider for the Job.

        • commitTime (datetime) --

          Commit date / time for the Job.

        • startTime (datetime) --

          Start date / time for the Job.

        • status (string) --

          Status for the Job.

        • endTime (datetime) --

          End date / time for the Job.

        • jobType (string) --

          Type for the Job.

      • steps (list) --

        Execution steps for an execution job, for an Amplify App.

        • (dict) --

          Structure for an execution step for an execution job, for an Amplify App.

          • stepName (string) --

            Name of the execution step.

          • startTime (datetime) --

            Start date/ time of the execution step.

          • status (string) --

            Status of the execution step.

          • endTime (datetime) --

            End date/ time of the execution step.

          • logUrl (string) --

            Url to the logs for the execution step.

          • artifactsUrl (string) --

            Url to teh artifact for the execution step.

          • screenshots (dict) --

            List of screenshot Urls for the execution step, if relevant.

            • (string) --
              • (string) --

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_apps(**kwargs)

Lists existing Amplify Apps.

See also: AWS API Documentation

Request Syntax

response = client.list_apps(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
  • maxResults (integer) -- Maximum number of records to list in a single response.
Return type

dict

Returns

Response Syntax

{
    'apps': [
        {
            'appId': 'string',
            'appArn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            },
            'description': 'string',
            'repository': 'string',
            'platform': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'iamServiceRoleArn': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'defaultDomain': 'string',
            'enableBranchAutoBuild': 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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Result structure for an Amplify App list request.

    • apps (list) --

      List of Amplify Apps.

      • (dict) --

        Amplify App represents different branches of a repository for building, deploying, and hosting.

        • appId (string) --

          Unique Id for the Amplify App.

        • appArn (string) --

          ARN for the Amplify App.

        • name (string) --

          Name for the Amplify App.

        • tags (dict) --

          Tag for Amplify App.

          • (string) --
            • (string) --
        • description (string) --

          Description for the Amplify App.

        • repository (string) --

          Repository for the Amplify App.

        • platform (string) --

          Platform for the Amplify App.

        • createTime (datetime) --

          Create date / time for the Amplify App.

        • updateTime (datetime) --

          Update date / time for the Amplify App.

        • iamServiceRoleArn (string) --

          IAM service role ARN for the Amplify App.

        • environmentVariables (dict) --

          Environment Variables for the Amplify App.

          • (string) --
            • (string) --
        • defaultDomain (string) --

          Default domain for the Amplify App.

        • enableBranchAutoBuild (boolean) --

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuth (boolean) --

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials (string) --

          Basic Authorization credentials for branches for the Amplify App.

        • customRules (list) --

          Custom redirect / rewrite rules for the Amplify App.

          • (dict) --

            Custom rewrite / 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, e.g. country code.

        • productionBranch (dict) --

          Structure with Production Branch information.

          • lastDeployTime (datetime) --

            Last Deploy Time of Production Branch.

          • status (string) --

            Status of Production Branch.

          • thumbnailUrl (string) --

            Thumbnail Url for Production Branch.

          • branchName (string) --

            Branch Name for Production Branch.

        • buildSpec (string) --

          BuildSpec content for Amplify App.

    • nextToken (string) --

      Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

list_branches(**kwargs)

Lists branches for an Amplify App.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    Unique Id for an Amplify App.

  • nextToken (string) -- Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.
  • maxResults (integer) -- 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',
            '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,
            'thumbnailUrl': 'string',
            'basicAuthCredentials': 'string',
            'buildSpec': 'string',
            'ttl': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Result structure for list branches request.

    • branches (list) --

      List of branches for an Amplify App.

      • (dict) --

        Branch for an Amplify App, which maps to a 3rd party repository branch.

        • branchArn (string) --

          ARN for a branch, part of an Amplify App.

        • branchName (string) --

          Name for a branch, part of an Amplify App.

        • description (string) --

          Description for a branch, part of an Amplify App.

        • tags (dict) --

          Tag for branch for Amplify App.

          • (string) --
            • (string) --
        • stage (string) --

          Stage for a branch, part of an Amplify App.

        • displayName (string) --

          Display name for a branch, part of an Amplify App.

        • enableNotification (boolean) --

          Enables notifications for a branch, part of an Amplify App.

        • createTime (datetime) --

          Creation date and time for a branch, part of an Amplify App.

        • updateTime (datetime) --

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariables (dict) --

          Environment Variables specific to a branch, part of an Amplify App.

          • (string) --
            • (string) --
        • enableAutoBuild (boolean) --

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomains (list) --

          Custom domains for a branch, part of an Amplify App.

          • (string) --
        • framework (string) --

          Framework for a branch, part of an Amplify App.

        • activeJobId (string) --

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobs (string) --

          Total number of Jobs part of an Amplify App.

        • enableBasicAuth (boolean) --

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl (string) --

          Thumbnail Url for the branch.

        • basicAuthCredentials (string) --

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec (string) --

          BuildSpec content for branch for Amplify App.

        • ttl (string) --

          The content TTL for the website in seconds.

    • nextToken (string) --

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

list_domain_associations(**kwargs)

List domains with an app

See also: AWS API Documentation

Request Syntax

response = client.list_domain_associations(
    appId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • nextToken (string) -- Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.
  • maxResults (integer) -- Maximum number of records to list in a single response.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Result structure for the list Domain Association request.

    • domainAssociations (list) --

      List of Domain Associations.

      • (dict) --

        Structure for Domain Association, which associates a custom domain with an Amplify App.

        • domainAssociationArn (string) --

          ARN for the Domain Association.

        • domainName (string) --

          Name of the domain.

        • enableAutoSubDomain (boolean) --

          Enables automated creation of Subdomains for branches.

        • domainStatus (string) --

          Status fo the Domain Association.

        • statusReason (string) --

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecord (string) --

          DNS Record for certificate verification.

        • subDomains (list) --

          Subdomains for the Domain Association.

          • (dict) --

            Subdomain for the Domain Association.

            • subDomainSetting (dict) --

              Setting structure for the Subdomain.

              • prefix (string) --

                Prefix setting for the Subdomain.

              • branchName (string) --

                Branch name setting for the Subdomain.

            • verified (boolean) --

              Verified status of the Subdomain

            • dnsRecord (string) --

              DNS record for the Subdomain.

    • nextToken (string) --

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

list_jobs(**kwargs)

List Jobs for a branch, part of an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.list_jobs(
    appId='string',
    branchName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for a branch.

  • nextToken (string) -- Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.
  • maxResults (integer) -- Maximum number of records to list in a single response.
Return type

dict

Returns

Response Syntax

{
    'jobSummaries': [
        {
            'jobArn': 'string',
            'jobId': 'string',
            'commitId': 'string',
            'commitMessage': 'string',
            'commitTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
            'endTime': datetime(2015, 1, 1),
            'jobType': 'RELEASE'|'RETRY'|'WEB_HOOK'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Maximum number of records to list in a single response.

    • jobSummaries (list) --

      Result structure for list job result request.

      • (dict) --

        Structure for the summary of a Job.

        • jobArn (string) --

          Arn for the Job.

        • jobId (string) --

          Unique Id for the Job.

        • commitId (string) --

          Commit Id from 3rd party repository provider for the Job.

        • commitMessage (string) --

          Commit message from 3rd party repository provider for the Job.

        • commitTime (datetime) --

          Commit date / time for the Job.

        • startTime (datetime) --

          Start date / time for the Job.

        • status (string) --

          Status for the Job.

        • endTime (datetime) --

          End date / time for the Job.

        • jobType (string) --

          Type for the Job.

    • nextToken (string) --

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

start_job(**kwargs)

Starts a new job for a branch, part of an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.start_job(
    appId='string',
    branchName='string',
    jobId='string',
    jobType='RELEASE'|'RETRY'|'WEB_HOOK',
    jobReason='string',
    commitId='string',
    commitMessage='string',
    commitTime=datetime(2015, 1, 1)
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch, for the Job.

  • jobId (string) -- Unique Id for the Job.
  • jobType (string) --

    [REQUIRED]

    Type for the Job.

  • jobReason (string) -- Reason for the Job.
  • commitId (string) -- Commit Id from 3rd party repository provider for the Job.
  • commitMessage (string) -- Commit message from 3rd party repository provider for the Job.
  • commitTime (datetime) -- Commit date / time for the Job.
Return type

dict

Returns

Response Syntax

{
    'jobSummary': {
        'jobArn': 'string',
        'jobId': 'string',
        'commitId': 'string',
        'commitMessage': 'string',
        'commitTime': datetime(2015, 1, 1),
        'startTime': datetime(2015, 1, 1),
        'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
        'endTime': datetime(2015, 1, 1),
        'jobType': 'RELEASE'|'RETRY'|'WEB_HOOK'
    }
}

Response Structure

  • (dict) --

    Result structure for run job request.

    • jobSummary (dict) --

      Summary for the Job.

      • jobArn (string) --

        Arn for the Job.

      • jobId (string) --

        Unique Id for the Job.

      • commitId (string) --

        Commit Id from 3rd party repository provider for the Job.

      • commitMessage (string) --

        Commit message from 3rd party repository provider for the Job.

      • commitTime (datetime) --

        Commit date / time for the Job.

      • startTime (datetime) --

        Start date / time for the Job.

      • status (string) --

        Status for the Job.

      • endTime (datetime) --

        End date / time for the Job.

      • jobType (string) --

        Type for the Job.

stop_job(**kwargs)

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.stop_job(
    appId='string',
    branchName='string',
    jobId='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch, for the Job.

  • jobId (string) --

    [REQUIRED]

    Unique Id for the Job.

Return type

dict

Returns

Response Syntax

{
    'jobSummary': {
        'jobArn': 'string',
        'jobId': 'string',
        'commitId': 'string',
        'commitMessage': 'string',
        'commitTime': datetime(2015, 1, 1),
        'startTime': datetime(2015, 1, 1),
        'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
        'endTime': datetime(2015, 1, 1),
        'jobType': 'RELEASE'|'RETRY'|'WEB_HOOK'
    }
}

Response Structure

  • (dict) --

    Result structure for the stop job request.

    • jobSummary (dict) --

      Summary for the Job.

      • jobArn (string) --

        Arn for the Job.

      • jobId (string) --

        Unique Id for the Job.

      • commitId (string) --

        Commit Id from 3rd party repository provider for the Job.

      • commitMessage (string) --

        Commit message from 3rd party repository provider for the Job.

      • commitTime (datetime) --

        Commit date / time for the Job.

      • startTime (datetime) --

        Start date / time for the Job.

      • status (string) --

        Status for the Job.

      • endTime (datetime) --

        End date / time for the Job.

      • jobType (string) --

        Type for the Job.

update_app(**kwargs)

Updates an existing Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.update_app(
    appId='string',
    name='string',
    description='string',
    platform='IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
    iamServiceRoleArn='string',
    environmentVariables={
        'string': 'string'
    },
    enableBranchAutoBuild=True|False,
    enableBasicAuth=True|False,
    basicAuthCredentials='string',
    customRules=[
        {
            'source': 'string',
            'target': 'string',
            'status': 'string',
            'condition': 'string'
        },
    ],
    buildSpec='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • name (string) -- Name for an Amplify App.
  • description (string) -- Description for an Amplify App.
  • platform (string) -- Platform for an Amplify App.
  • iamServiceRoleArn (string) -- IAM service role for an Amplify App.
  • environmentVariables (dict) --

    Environment Variables for an Amplify App.

    • (string) --
      • (string) --
  • enableBranchAutoBuild (boolean) -- Enables branch auto-building for an Amplify App.
  • enableBasicAuth (boolean) -- Enables Basic Authorization for an Amplify App.
  • basicAuthCredentials (string) -- Basic Authorization credentials for an Amplify App.
  • customRules (list) --

    Custom redirect / rewrite rules for an Amplify App.

    • (dict) --

      Custom rewrite / 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, e.g. country code.

  • buildSpec (string) -- BuildSpec 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': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'iamServiceRoleArn': 'string',
        'environmentVariables': {
            'string': 'string'
        },
        'defaultDomain': 'string',
        'enableBranchAutoBuild': 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'
    }
}

Response Structure

  • (dict) --

    Result structure for an Amplify App update request.

    • app (dict) --

      App structure for the updated App.

      • appId (string) --

        Unique Id for the Amplify App.

      • appArn (string) --

        ARN for the Amplify App.

      • name (string) --

        Name for the Amplify App.

      • tags (dict) --

        Tag for Amplify App.

        • (string) --
          • (string) --
      • description (string) --

        Description for the Amplify App.

      • repository (string) --

        Repository for the Amplify App.

      • platform (string) --

        Platform for the Amplify App.

      • createTime (datetime) --

        Create date / time for the Amplify App.

      • updateTime (datetime) --

        Update date / time for the Amplify App.

      • iamServiceRoleArn (string) --

        IAM service role ARN for the Amplify App.

      • environmentVariables (dict) --

        Environment Variables for the Amplify App.

        • (string) --
          • (string) --
      • defaultDomain (string) --

        Default domain for the Amplify App.

      • enableBranchAutoBuild (boolean) --

        Enables auto-building of branches for the Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for branches for the Amplify App.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for branches for the Amplify App.

      • customRules (list) --

        Custom redirect / rewrite rules for the Amplify App.

        • (dict) --

          Custom rewrite / 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, e.g. country code.

      • productionBranch (dict) --

        Structure with Production Branch information.

        • lastDeployTime (datetime) --

          Last Deploy Time of Production Branch.

        • status (string) --

          Status of Production Branch.

        • thumbnailUrl (string) --

          Thumbnail Url for Production Branch.

        • branchName (string) --

          Branch Name for Production Branch.

      • buildSpec (string) --

        BuildSpec content for Amplify App.

update_branch(**kwargs)

Updates a branch for an Amplify App.

See also: AWS API Documentation

Request Syntax

response = client.update_branch(
    appId='string',
    branchName='string',
    description='string',
    framework='string',
    stage='PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
    enableNotification=True|False,
    enableAutoBuild=True|False,
    environmentVariables={
        'string': 'string'
    },
    basicAuthCredentials='string',
    enableBasicAuth=True|False,
    buildSpec='string',
    ttl='string'
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for the branch.

  • description (string) -- Description for the branch.
  • framework (string) -- Framework for the branch.
  • stage (string) -- Stage for the branch.
  • enableNotification (boolean) -- Enables notifications for the branch.
  • enableAutoBuild (boolean) -- Enables auto building for the branch.
  • environmentVariables (dict) --

    Environment Variables for the branch.

    • (string) --
      • (string) --
  • basicAuthCredentials (string) -- Basic Authorization credentials for the branch.
  • enableBasicAuth (boolean) -- Enables Basic Auth for the branch.
  • buildSpec (string) -- BuildSpec for the branch.
  • ttl (string) -- The content TTL for the website in seconds.
Return type

dict

Returns

Response Syntax

{
    'branch': {
        'branchArn': 'string',
        'branchName': 'string',
        'description': 'string',
        'tags': {
            'string': 'string'
        },
        'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
        '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,
        'thumbnailUrl': 'string',
        'basicAuthCredentials': 'string',
        'buildSpec': 'string',
        'ttl': 'string'
    }
}

Response Structure

  • (dict) --

    Result structure for update branch request.

    • branch (dict) --

      Branch structure for an Amplify App.

      • branchArn (string) --

        ARN for a branch, part of an Amplify App.

      • branchName (string) --

        Name for a branch, part of an Amplify App.

      • description (string) --

        Description for a branch, part of an Amplify App.

      • tags (dict) --

        Tag for branch for Amplify App.

        • (string) --
          • (string) --
      • stage (string) --

        Stage for a branch, part of an Amplify App.

      • displayName (string) --

        Display name for a branch, part of an Amplify App.

      • enableNotification (boolean) --

        Enables notifications for a branch, part of an Amplify App.

      • createTime (datetime) --

        Creation date and time for a branch, part of an Amplify App.

      • updateTime (datetime) --

        Last updated date and time for a branch, part of an Amplify App.

      • environmentVariables (dict) --

        Environment Variables specific to a branch, part of an Amplify App.

        • (string) --
          • (string) --
      • enableAutoBuild (boolean) --

        Enables auto-building on push for a branch, part of an Amplify App.

      • customDomains (list) --

        Custom domains for a branch, part of an Amplify App.

        • (string) --
      • framework (string) --

        Framework for a branch, part of an Amplify App.

      • activeJobId (string) --

        Id of the active job for a branch, part of an Amplify App.

      • totalNumberOfJobs (string) --

        Total number of Jobs part of an Amplify App.

      • enableBasicAuth (boolean) --

        Enables Basic Authorization for a branch, part of an Amplify App.

      • thumbnailUrl (string) --

        Thumbnail Url for the branch.

      • basicAuthCredentials (string) --

        Basic Authorization credentials for a branch, part of an Amplify App.

      • buildSpec (string) --

        BuildSpec content for branch for Amplify App.

      • ttl (string) --

        The content TTL for the website in seconds.

update_domain_association(**kwargs)

Create a new DomainAssociation on an App

See also: AWS API Documentation

Request Syntax

response = client.update_domain_association(
    appId='string',
    domainName='string',
    enableAutoSubDomain=True|False,
    subDomainSettings=[
        {
            'prefix': 'string',
            'branchName': 'string'
        },
    ]
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • domainName (string) --

    [REQUIRED]

    Name of the domain.

  • enableAutoSubDomain (boolean) -- Enables automated creation of Subdomains for branches.
  • subDomainSettings (list) --

    [REQUIRED]

    Setting structure for the Subdomain.

    • (dict) --

      Setting for the Subdomain.

      • prefix (string) -- [REQUIRED]

        Prefix setting for the Subdomain.

      • branchName (string) -- [REQUIRED]

        Branch name setting for the Subdomain.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Result structure for the update Domain Association request.

    • domainAssociation (dict) --

      Domain Association structure.

      • domainAssociationArn (string) --

        ARN for the Domain Association.

      • domainName (string) --

        Name of the domain.

      • enableAutoSubDomain (boolean) --

        Enables automated creation of Subdomains for branches.

      • domainStatus (string) --

        Status fo the Domain Association.

      • statusReason (string) --

        Reason for the current status of the Domain Association.

      • certificateVerificationDNSRecord (string) --

        DNS Record for certificate verification.

      • subDomains (list) --

        Subdomains for the Domain Association.

        • (dict) --

          Subdomain for the Domain Association.

          • subDomainSetting (dict) --

            Setting structure for the Subdomain.

            • prefix (string) --

              Prefix setting for the Subdomain.

            • branchName (string) --

              Branch name setting for the Subdomain.

          • verified (boolean) --

            Verified status of the Subdomain

          • dnsRecord (string) --

            DNS record for the Subdomain.

Paginators

The available paginators are:

class Amplify.Paginator.ListApps
paginator = client.get_paginator('list_apps')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Amplify.Client.list_apps().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'apps': [
        {
            'appId': 'string',
            'appArn': 'string',
            'name': 'string',
            'tags': {
                'string': 'string'
            },
            'description': 'string',
            'repository': 'string',
            'platform': 'IOS'|'ANDROID'|'WEB'|'REACT_NATIVE',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'iamServiceRoleArn': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'defaultDomain': 'string',
            'enableBranchAutoBuild': 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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Result structure for an Amplify App list request.

    • apps (list) --

      List of Amplify Apps.

      • (dict) --

        Amplify App represents different branches of a repository for building, deploying, and hosting.

        • appId (string) --

          Unique Id for the Amplify App.

        • appArn (string) --

          ARN for the Amplify App.

        • name (string) --

          Name for the Amplify App.

        • tags (dict) --

          Tag for Amplify App.

          • (string) --
            • (string) --
        • description (string) --

          Description for the Amplify App.

        • repository (string) --

          Repository for the Amplify App.

        • platform (string) --

          Platform for the Amplify App.

        • createTime (datetime) --

          Create date / time for the Amplify App.

        • updateTime (datetime) --

          Update date / time for the Amplify App.

        • iamServiceRoleArn (string) --

          IAM service role ARN for the Amplify App.

        • environmentVariables (dict) --

          Environment Variables for the Amplify App.

          • (string) --
            • (string) --
        • defaultDomain (string) --

          Default domain for the Amplify App.

        • enableBranchAutoBuild (boolean) --

          Enables auto-building of branches for the Amplify App.

        • enableBasicAuth (boolean) --

          Enables Basic Authorization for branches for the Amplify App.

        • basicAuthCredentials (string) --

          Basic Authorization credentials for branches for the Amplify App.

        • customRules (list) --

          Custom redirect / rewrite rules for the Amplify App.

          • (dict) --

            Custom rewrite / 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, e.g. country code.

        • productionBranch (dict) --

          Structure with Production Branch information.

          • lastDeployTime (datetime) --

            Last Deploy Time of Production Branch.

          • status (string) --

            Status of Production Branch.

          • thumbnailUrl (string) --

            Thumbnail Url for Production Branch.

          • branchName (string) --

            Branch Name for Production Branch.

        • buildSpec (string) --

          BuildSpec content for Amplify App.

    • NextToken (string) --

      A token to resume pagination.

class Amplify.Paginator.ListBranches
paginator = client.get_paginator('list_branches')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Amplify.Client.list_branches().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    appId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'branches': [
        {
            'branchArn': 'string',
            'branchName': 'string',
            'description': 'string',
            'tags': {
                'string': 'string'
            },
            'stage': 'PRODUCTION'|'BETA'|'DEVELOPMENT'|'EXPERIMENTAL',
            '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,
            'thumbnailUrl': 'string',
            'basicAuthCredentials': 'string',
            'buildSpec': 'string',
            'ttl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Result structure for list branches request.

    • branches (list) --

      List of branches for an Amplify App.

      • (dict) --

        Branch for an Amplify App, which maps to a 3rd party repository branch.

        • branchArn (string) --

          ARN for a branch, part of an Amplify App.

        • branchName (string) --

          Name for a branch, part of an Amplify App.

        • description (string) --

          Description for a branch, part of an Amplify App.

        • tags (dict) --

          Tag for branch for Amplify App.

          • (string) --
            • (string) --
        • stage (string) --

          Stage for a branch, part of an Amplify App.

        • displayName (string) --

          Display name for a branch, part of an Amplify App.

        • enableNotification (boolean) --

          Enables notifications for a branch, part of an Amplify App.

        • createTime (datetime) --

          Creation date and time for a branch, part of an Amplify App.

        • updateTime (datetime) --

          Last updated date and time for a branch, part of an Amplify App.

        • environmentVariables (dict) --

          Environment Variables specific to a branch, part of an Amplify App.

          • (string) --
            • (string) --
        • enableAutoBuild (boolean) --

          Enables auto-building on push for a branch, part of an Amplify App.

        • customDomains (list) --

          Custom domains for a branch, part of an Amplify App.

          • (string) --
        • framework (string) --

          Framework for a branch, part of an Amplify App.

        • activeJobId (string) --

          Id of the active job for a branch, part of an Amplify App.

        • totalNumberOfJobs (string) --

          Total number of Jobs part of an Amplify App.

        • enableBasicAuth (boolean) --

          Enables Basic Authorization for a branch, part of an Amplify App.

        • thumbnailUrl (string) --

          Thumbnail Url for the branch.

        • basicAuthCredentials (string) --

          Basic Authorization credentials for a branch, part of an Amplify App.

        • buildSpec (string) --

          BuildSpec content for branch for Amplify App.

        • ttl (string) --

          The content TTL for the website in seconds.

    • NextToken (string) --

      A token to resume pagination.

class Amplify.Paginator.ListDomainAssociations
paginator = client.get_paginator('list_domain_associations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Amplify.Client.list_domain_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    appId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Result structure for the list Domain Association request.

    • domainAssociations (list) --

      List of Domain Associations.

      • (dict) --

        Structure for Domain Association, which associates a custom domain with an Amplify App.

        • domainAssociationArn (string) --

          ARN for the Domain Association.

        • domainName (string) --

          Name of the domain.

        • enableAutoSubDomain (boolean) --

          Enables automated creation of Subdomains for branches.

        • domainStatus (string) --

          Status fo the Domain Association.

        • statusReason (string) --

          Reason for the current status of the Domain Association.

        • certificateVerificationDNSRecord (string) --

          DNS Record for certificate verification.

        • subDomains (list) --

          Subdomains for the Domain Association.

          • (dict) --

            Subdomain for the Domain Association.

            • subDomainSetting (dict) --

              Setting structure for the Subdomain.

              • prefix (string) --

                Prefix setting for the Subdomain.

              • branchName (string) --

                Branch name setting for the Subdomain.

            • verified (boolean) --

              Verified status of the Subdomain

            • dnsRecord (string) --

              DNS record for the Subdomain.

    • NextToken (string) --

      A token to resume pagination.

class Amplify.Paginator.ListJobs
paginator = client.get_paginator('list_jobs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Amplify.Client.list_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    appId='string',
    branchName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • appId (string) --

    [REQUIRED]

    Unique Id for an Amplify App.

  • branchName (string) --

    [REQUIRED]

    Name for a branch.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'jobSummaries': [
        {
            'jobArn': 'string',
            'jobId': 'string',
            'commitId': 'string',
            'commitMessage': 'string',
            'commitTime': datetime(2015, 1, 1),
            'startTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'PROVISIONING'|'RUNNING'|'FAILED'|'SUCCEED'|'CANCELLING'|'CANCELLED',
            'endTime': datetime(2015, 1, 1),
            'jobType': 'RELEASE'|'RETRY'|'WEB_HOOK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Maximum number of records to list in a single response.

    • jobSummaries (list) --

      Result structure for list job result request.

      • (dict) --

        Structure for the summary of a Job.

        • jobArn (string) --

          Arn for the Job.

        • jobId (string) --

          Unique Id for the Job.

        • commitId (string) --

          Commit Id from 3rd party repository provider for the Job.

        • commitMessage (string) --

          Commit message from 3rd party repository provider for the Job.

        • commitTime (datetime) --

          Commit date / time for the Job.

        • startTime (datetime) --

          Start date / time for the Job.

        • status (string) --

          Status for the Job.

        • endTime (datetime) --

          End date / time for the Job.

        • jobType (string) --

          Type for the Job.

    • NextToken (string) --

      A token to resume pagination.