Proton / Client / get_service

get_service

Proton.Client.get_service(**kwargs)

Get detailed data for a service.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.get_service(
    name='string'
)
Parameters:

name (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'service': {
        'arn': 'string',
        'branchName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        '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'
        },
        'repositoryConnectionArn': 'string',
        'repositoryId': 'string',
        'spec': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

  • (dict) –

    • service (dict) –

      The detailed data of the requested service.

      • arn (string) –

        The Amazon Resource Name (ARN) of the service.

      • branchName (string) –

        The name of the code repository branch that holds the code that’s deployed in Proton.

      • createdAt (datetime) –

        The time when the service was created.

      • description (string) –

        A description of the service.

      • lastModifiedAt (datetime) –

        The time when the service was last modified.

      • name (string) –

        The name of the service.

      • pipeline (dict) –

        The service pipeline detail data.

        • 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.

      • repositoryConnectionArn (string) –

        The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

      • repositoryId (string) –

        The ID of the source code repository.

      • spec (string) –

        The formatted specification that defines the service.

      • status (string) –

        The status of the service.

      • statusMessage (string) –

        A service status message.

      • templateName (string) –

        The name of the service template.

Exceptions