Proton / Client / cancel_environment_deployment

cancel_environment_deployment#

Proton.Client.cancel_environment_deployment(**kwargs)#

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the Proton User guide.

The following list includes potential cancellation scenarios.

If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Request Syntax

response = client.cancel_environment_deployment(
    environmentName='string'
)

Parameters:

environmentName (string) –

[REQUIRED]

The name of the environment with the deployment to cancel.

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',
        'lastAttemptedDeploymentId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'lastSucceededDeploymentId': 'string',
        '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 environment summary data that’s returned by Proton.
  - 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.
  - lastAttemptedDeploymentId (string) –
    
    The ID of the last attempted deployment of this environment.
  - lastDeploymentAttemptedAt (datetime) –
    
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) –
    
    The time when the environment was last deployed successfully.
  - lastSucceededDeploymentId (string) –
    
    The ID of the last successful deployment of this environment.
  - 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.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException