Proton / Client / update_service_pipeline

update_service_pipeline#

Proton.Client.update_service_pipeline(**kwargs)#

Update the service pipeline.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that’s higher than the major version in use and a minor version.

See also: AWS API Documentation

Request Syntax

response = client.update_service_pipeline(
    deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
    serviceName='string',
    spec='string',
    templateMajorVersion='string',
    templateMinorVersion='string'
)
Parameters:

  • deploymentType (string) –

    [REQUIRED]

    The deployment type.

    There are four modes for updating a service pipeline. The deploymentType field defines the mode.

    NONE

    In this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated.

    CURRENT_VERSION

    In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type.

    MINOR_VERSION

    In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.

    MAJOR_VERSION

    In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that’s higher than the major version in use and a minor version.

  • serviceName (string) –

    [REQUIRED]

    The name of the service to that the pipeline is associated with.

  • spec (string) –

    [REQUIRED]

    The spec for the service pipeline to update.

  • templateMajorVersion (string) – The major version of the service template that was used to create the service that the pipeline is associated with.

  • templateMinorVersion (string) – The minor version of the service template that was used to create the service that the pipeline is associated with.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • pipeline (dict) –

      The pipeline details that are returned by Proton.

      • arn (string) –

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

      • createdAt (datetime) –

        The time when the service pipeline was created.

      • deploymentStatus (string) –

        The deployment status of the service pipeline.

      • deploymentStatusMessage (string) –

        A service pipeline deployment status message.

      • lastAttemptedDeploymentId (string) –

        The ID of the last attempted deployment of this service pipeline.

      • lastDeploymentAttemptedAt (datetime) –

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

      • lastDeploymentSucceededAt (datetime) –

        The time when the service pipeline was last deployed successfully.

      • lastSucceededDeploymentId (string) –

        The ID of the last successful deployment of this service pipeline.

      • spec (string) –

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

      • templateMajorVersion (string) –

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

      • templateMinorVersion (string) –

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

      • templateName (string) –

        The name of the service template that was used to create the service pipeline.

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