Proton / Client / cancel_component_deployment

cancel_component_deployment

Proton.Client.cancel_component_deployment(**kwargs)

Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).

For more information about components, see Proton components in the Proton User Guide.

See also: AWS API Documentation

Request Syntax

response = client.cancel_component_deployment(
    componentName='string'
)

Parameters:

componentName (string) –

[REQUIRED]

The name of the component with the deployment to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'component': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentName': 'string',
        'lastClientRequestToken': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'serviceInstanceName': 'string',
        'serviceName': 'string',
        'serviceSpec': 'string'
    }
}

Response Structure

• (dict) –

  • component (dict) –

    The detailed data of the component with the deployment that is being canceled.

    • arn (string) –

      The Amazon Resource Name (ARN) of the component.

    • createdAt (datetime) –

      The time when the component was created.

    • deploymentStatus (string) –

      The component deployment status.

    • deploymentStatusMessage (string) –

      The message associated with the component deployment status.

    • description (string) –

      A description of the component.

    • environmentName (string) –

      The name of the Proton environment that this component is associated with.

    • lastClientRequestToken (string) –

      The last token the client requested.

    • lastDeploymentAttemptedAt (datetime) –

      The time when a deployment of the component was last attempted.

    • lastDeploymentSucceededAt (datetime) –

      The time when the component was last deployed successfully.

    • lastModifiedAt (datetime) –

      The time when the component was last modified.

    • name (string) –

      The name of the component.

    • serviceInstanceName (string) –

      The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

    • serviceName (string) –

      The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

    • serviceSpec (string) –

      The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

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