Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . proton ]

get-service-instance

Description

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-service-instance
--name <value>
--service-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

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

--service-name (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get service instance details

The following get-service-instance example gets detail data for a service instance.

aws proton get-service-instance \
    --name "instance-one" \
    --service-name "simple-svc"

Output:

{
    "serviceInstance": {
        "arn": "arn:aws:proton:region-id:123456789012:service/simple-svc/service-instance/instance-one",
        "createdAt": "2020-11-28T22:40:50.512000+00:00",
        "deploymentStatus": "SUCCEEDED",
        "environmentName": "simple-env",
        "lastDeploymentAttemptedAt": "2020-11-28T22:40:50.512000+00:00",
        "lastDeploymentSucceededAt": "2020-11-28T22:40:50.512000+00:00",
        "name": "instance-one",
        "serviceName": "simple-svc",
        "spec": "proton: ServiceSpec\npipeline:\n  my_sample_pipeline_optional_input: hello world\n  my_sample_pipeline_required_input: pipeline up\ninstances:\n- name: instance-one\n  environment: my-simple-env\n  spec:\n    my_sample_service_instance_optional_input: Ola\n    my_sample_service_instance_required_input: Ciao\n",
        "templateMajorVersion": "1",
        "templateMinorVersion": "0",
        "templateName": "svc-simple"
    }
}

For more information, see View service data in the The AWS Proton Administrator Guide or View service data in the The AWS Proton User Guide.

Output

serviceInstance -> (structure)

The detailed data of the requested service instance.

arn -> (string)

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

createdAt -> (timestamp)

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 -> (timestamp)

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

lastDeploymentSucceededAt -> (timestamp)

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.