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-deployment

Description

Get detailed data for a deployment.

See also: AWS API Documentation

Synopsis

  get-deployment
[--component-name <value>]
[--environment-name <value>]
--id <value>
[--service-instance-name <value>]
[--service-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--component-name (string)

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

--environment-name (string)

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

--id (string)

The ID of the deployment that you want to get the detailed data for.

--service-instance-name (string)

The name of the service instance associated with the given deployment ID. serviceName must be specified to identify the service instance.

--service-name (string)

The name of the service associated with the given deployment ID.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

deployment -> (structure)

The detailed data of the requested deployment.

arn -> (string)

The Amazon Resource Name (ARN) of the deployment.

completedAt -> (timestamp)

The date and time the deployment was completed.

componentName -> (string)

The name of the component associated with this deployment.

createdAt -> (timestamp)

The date and time the deployment was created.

deploymentStatus -> (string)

The status of the deployment.

deploymentStatusMessage -> (string)

The deployment status message.

environmentName -> (string)

The name of the environment associated with this deployment.

id -> (string)

The ID of the deployment.

initialState -> (tagged union structure)

The initial state of the target resource at the time of the deployment.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: component, environment, serviceInstance, servicePipeline.

component -> (structure)

The state of the component associated with the deployment.

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.

templateFile -> (string)

The template file used.

environment -> (structure)

The state of the environment associated with the deployment.

spec -> (string)

The environment spec that was used to create the environment.

templateMajorVersion -> (string)

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

templateMinorVersion -> (string)

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

templateName -> (string)

The name of the environment template that was used to create the environment.

serviceInstance -> (structure)

The state of the service instance associated with the deployment.

lastSuccessfulComponentDeploymentIds -> (list)

The IDs for the last successful components deployed for this service instance.

(string)

lastSuccessfulEnvironmentDeploymentId -> (string)

The ID for the last successful environment deployed for this service instance.

lastSuccessfulServicePipelineDeploymentId -> (string)

The ID for the last successful service pipeline deployed for this service instance.

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

servicePipeline -> (structure)

The state of the service pipeline associated with the deployment.

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.

lastAttemptedDeploymentId -> (string)

The ID of the last attempted deployment.

lastModifiedAt -> (timestamp)

The date and time the deployment was last modified.

lastSucceededDeploymentId -> (string)

The ID of the last successful deployment.

serviceInstanceName -> (string)

The name of the deployment's service instance.

serviceName -> (string)

The name of the service in this deployment.

targetArn -> (string)

The Amazon Resource Name (ARN) of the target of the deployment.

targetResourceCreatedAt -> (timestamp)

The date and time the depoyment target was created.

targetResourceType -> (string)

The resource type of the deployment target. It can be an environment, service, service instance, or component.

targetState -> (tagged union structure)

The target state of the target resource at the time of the deployment.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: component, environment, serviceInstance, servicePipeline.

component -> (structure)

The state of the component associated with the deployment.

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.

templateFile -> (string)

The template file used.

environment -> (structure)

The state of the environment associated with the deployment.

spec -> (string)

The environment spec that was used to create the environment.

templateMajorVersion -> (string)

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

templateMinorVersion -> (string)

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

templateName -> (string)

The name of the environment template that was used to create the environment.

serviceInstance -> (structure)

The state of the service instance associated with the deployment.

lastSuccessfulComponentDeploymentIds -> (list)

The IDs for the last successful components deployed for this service instance.

(string)

lastSuccessfulEnvironmentDeploymentId -> (string)

The ID for the last successful environment deployed for this service instance.

lastSuccessfulServicePipelineDeploymentId -> (string)

The ID for the last successful service pipeline deployed for this service instance.

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

servicePipeline -> (structure)

The state of the service pipeline associated with the deployment.

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.