cancel_service_instance_deployment

Proton.Client.cancel_service_instance_deployment(**kwargs)

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS . For more information, see Update a service instance 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 UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

See also: AWS API Documentation

Request Syntax

response = client.cancel_service_instance_deployment(
    serviceInstanceName='string',
    serviceName='string'
)

Parameters

• serviceInstanceName (string) --

  [REQUIRED]

  The name of the service instance with the deployment to cancel.

• serviceName (string) --

  [REQUIRED]

  The name of the service with the service instance deployment to cancel.

Return type

dict

Returns

Response Syntax

{
    'serviceInstance': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'environmentName': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'serviceName': 'string',
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

• (dict) --

  • serviceInstance (dict) --

    The service instance summary data that's returned by Proton.

    • arn (string) --

      The Amazon Resource Name (ARN) of the service instance.

    • createdAt (datetime) --

      The time when the service instance was created.

    • deploymentStatus (string) --

      The service instance deployment status.

    • deploymentStatusMessage (string) --

      The message associated with the service instance deployment status.

    • environmentName (string) --

      The name of the environment that the service instance was deployed into.

    • lastDeploymentAttemptedAt (datetime) --

      The time when a deployment of the service instance was last attempted.

    • lastDeploymentSucceededAt (datetime) --

      The time when the service instance was last deployed successfully.

    • name (string) --

      The name of the service instance.

    • serviceName (string) --

      The name of the service that the service instance belongs to.

    • spec (string) --

      The service spec that was used to create the service instance.

    • templateMajorVersion (string) --

      The major version of the service template that was used to create the service instance.

    • templateMinorVersion (string) --

      The minor version of the service template that was used to create the service instance.

    • templateName (string) --

      The name of the service template that was used to create the 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