Proton / Client / get_environment

get_environment#

Proton.Client.get_environment(**kwargs)#

Get detailed data for an environment.

Request Syntax

response = client.get_environment(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the environment that you want to get the detailed data for.

Return type:

dict

Returns:

Response Syntax

{
    'environment': {
        'arn': 'string',
        'codebuildRoleArn': 'string',
        'componentRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentAccountConnectionId': 'string',
        'environmentAccountId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'protonServiceRoleArn': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'provisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) –
- environment (dict) –
  
  The detailed data of the requested environment.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the environment.
  - codebuildRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
  - componentRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
    
    The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
    
    For more information about components, see Proton components in the Proton User Guide.
  - createdAt (datetime) –
    
    The time when the environment was created.
  - deploymentStatus (string) –
    
    The environment deployment status.
  - deploymentStatusMessage (string) –
    
    An environment deployment status message.
  - description (string) –
    
    The description of the environment.
  - environmentAccountConnectionId (string) –
    
    The ID of the environment account connection that’s used to provision infrastructure resources in an environment account.
  - environmentAccountId (string) –
    
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - lastDeploymentAttemptedAt (datetime) –
    
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) –
    
    The time when the environment was last deployed successfully.
  - name (string) –
    
    The name of the environment.
  - protonServiceRoleArn (string) –
    
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning (string) –
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - provisioningRepository (dict) –
    
    The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the linked repository.
    - branch (string) –
      
      The repository branch.
    - name (string) –
      
      The repository name.
    - provider (string) –
      
      The repository provider.
  - spec (string) –
    
    The environment spec.
  - templateMajorVersion (string) –
    
    The major version of the environment template.
  - templateMinorVersion (string) –
    
    The minor version of the environment template.
  - templateName (string) –
    
    The Amazon Resource Name (ARN) of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException