AWS Amplify

Lists backend environments for an Amplify App.

See also: AWS API Documentation

Request Syntax

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

type appId:

string

param appId:

[REQUIRED]

Unique Id for an amplify App.

type environmentName:

string

param environmentName:

Name of the backend environment

type nextToken:

string

param nextToken:

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

type maxResults:

integer

param maxResults:

Maximum number of records to list in a single response.

rtype:

dict

returns:

Response Syntax

{
    'backendEnvironments': [
        {
            'backendEnvironmentArn': 'string',
            'environmentName': 'string',
            'stackName': 'string',
            'deploymentArtifacts': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  Result structure for list backend environments result.

  • backendEnvironments (list) --

    List of backend environments for an Amplify App.

    • (dict) --

      Backend environment for an Amplify App.

      • backendEnvironmentArn (string) --

        Arn for a backend environment, part of an Amplify App.

      • environmentName (string) --

        Name for a backend environment, part of an Amplify App.

      • stackName (string) --

        CloudFormation stack name of backend environment.

      • deploymentArtifacts (string) --

        Name of deployment artifacts.

      • createTime (datetime) --

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

      • updateTime (datetime) --

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

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

Delete backend environment for an Amplify App.

See also: AWS API Documentation

Request Syntax

client.delete_backend_environment(
    appId='string',
    environmentName='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id of an Amplify App.

type environmentName:

string

param environmentName:

[REQUIRED]

Name of a backend environment of an Amplify App.

rtype:

dict

returns:

Response Syntax

{
    'backendEnvironment': {
        'backendEnvironmentArn': 'string',
        'environmentName': 'string',
        'stackName': 'string',
        'deploymentArtifacts': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  Result structure of a delete backend environment result.

  • backendEnvironment (dict) --

    Backend environment structure for an Amplify App.

    • backendEnvironmentArn (string) --

      Arn for a backend environment, part of an Amplify App.

    • environmentName (string) --

      Name for a backend environment, part of an Amplify App.

    • stackName (string) --

      CloudFormation stack name of backend environment.

    • deploymentArtifacts (string) --

      Name of deployment artifacts.

    • createTime (datetime) --

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

    • updateTime (datetime) --

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

Creates a new backend environment for an Amplify App.

See also: AWS API Documentation

Request Syntax

client.create_backend_environment(
    appId='string',
    environmentName='string',
    stackName='string',
    deploymentArtifacts='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type environmentName:

string

param environmentName:

[REQUIRED]

Name for the backend environment.

type stackName:

string

param stackName:

CloudFormation stack name of backend environment.

type deploymentArtifacts:

string

param deploymentArtifacts:

Name of deployment artifacts.

rtype:

dict

returns:

Response Syntax

{
    'backendEnvironment': {
        'backendEnvironmentArn': 'string',
        'environmentName': 'string',
        'stackName': 'string',
        'deploymentArtifacts': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  Result structure for create backend environment.

  • backendEnvironment (dict) --

    Backend environment structure for an amplify App.

    • backendEnvironmentArn (string) --

      Arn for a backend environment, part of an Amplify App.

    • environmentName (string) --

      Name for a backend environment, part of an Amplify App.

    • stackName (string) --

      CloudFormation stack name of backend environment.

    • deploymentArtifacts (string) --

      Name of deployment artifacts.

    • createTime (datetime) --

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

    • updateTime (datetime) --

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

Retrieves a backend environment for an Amplify App.

See also: AWS API Documentation

Request Syntax

client.get_backend_environment(
    appId='string',
    environmentName='string'
)

type appId:

string

param appId:

[REQUIRED]

Unique Id for an Amplify App.

type environmentName:

string

param environmentName:

[REQUIRED]

Name for the backend environment.

rtype:

dict

returns:

Response Syntax

{
    'backendEnvironment': {
        'backendEnvironmentArn': 'string',
        'environmentName': 'string',
        'stackName': 'string',
        'deploymentArtifacts': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  Result structure for get backend environment result.

  • backendEnvironment (dict) --

    Backend environment structure for an an Amplify App.

    • backendEnvironmentArn (string) --

      Arn for a backend environment, part of an Amplify App.

    • environmentName (string) --

      Name for a backend environment, part of an Amplify App.

    • stackName (string) --

      CloudFormation stack name of backend environment.

    • deploymentArtifacts (string) --

      Name of deployment artifacts.

    • createTime (datetime) --

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

    • updateTime (datetime) --

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