get_backend_environment

Amplify.Client.get_backend_environment(**kwargs)

Returns a backend environment for an Amplify app.

See also: AWS API Documentation

Request Syntax

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

Parameters

• appId (string) --

  [REQUIRED]

  The unique id for an Amplify app.

• environmentName (string) --

  [REQUIRED]

  The name for the backend environment.

Return type

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) --

  The result structure for the get backend environment result.

  • backendEnvironment (dict) --

    Describes the backend environment for an Amplify app.

    • backendEnvironmentArn (string) --

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

    • environmentName (string) --

      The name for a backend environment that is part of an Amplify app.

    • stackName (string) --

      The AWS CloudFormation stack name of a backend environment.

    • deploymentArtifacts (string) --

      The name of deployment artifacts.

    • createTime (datetime) --

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

    • updateTime (datetime) --

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

Exceptions

• Amplify.Client.exceptions.BadRequestException
• Amplify.Client.exceptions.UnauthorizedException
• Amplify.Client.exceptions.NotFoundException
• Amplify.Client.exceptions.InternalFailureException