[ aws . ecs ]

list-daemon-deployments

Description

Returns a list of daemon deployments for a specified daemon. You can filter the results by status or creation time.

See also: AWS API Documentation

Synopsis

  list-daemon-deployments
--daemon-arn <value>
[--status <value>]
[--created-at <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--daemon-arn (string) [required]

The Amazon Resource Name (ARN) of the daemon to list deployments for.

--status (list)

An optional filter to narrow the ListDaemonDeployments results by deployment status. If you don’t specify a status, all deployments are returned.

(string)

Possible values:

  • PENDING
  • SUCCESSFUL
  • STOPPED
  • STOP_REQUESTED
  • IN_PROGRESS
  • ROLLBACK_IN_PROGRESS
  • ROLLBACK_SUCCESSFUL
  • ROLLBACK_FAILED

Syntax:

"string" "string" ...

--created-at (structure)

An optional filter to narrow the ListDaemonDeployments results by creation time. If you don’t specify a time range, all deployments are returned.

before -> (timestamp)

Include service deployments in the result that were created before this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

after -> (timestamp)

Include service deployments in the result that were created after this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

Shorthand Syntax:

before=timestamp,after=timestamp

JSON Syntax:

{
  "before": timestamp,
  "after": timestamp
}

--max-results (integer)

The maximum number of daemon deployment results that ListDaemonDeployments returned in paginated output. When this parameter is used, ListDaemonDeployments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDaemonDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn’t used, then ListDaemonDeployments returns up to 20 results and a nextToken value if applicable.

--next-token (string)

The nextToken value returned from a ListDaemonDeployments request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it’s possible for the number of results to be fewer than maxResults .

Note

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

nextToken -> (string)

The nextToken value to include in a future ListDaemonDeployments request. When the results of a ListDaemonDeployments request exceed maxResults , this value can be used to retrieve the next page of results.

daemonDeployments -> (list)

The list of daemon deployment summaries.

(structure)

A summary of a daemon deployment.

daemonDeploymentArn -> (string)

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

daemonArn -> (string)

The Amazon Resource Name (ARN) of the daemon.

clusterArn -> (string)

The Amazon Resource Name (ARN) of the cluster that hosts the daemon.

status -> (string)

The status of the daemon deployment.

Possible values:

  • PENDING
  • SUCCESSFUL
  • STOPPED
  • STOP_REQUESTED
  • IN_PROGRESS
  • ROLLBACK_IN_PROGRESS
  • ROLLBACK_SUCCESSFUL
  • ROLLBACK_FAILED

statusReason -> (string)

Information about why the daemon deployment is in the current status.

targetDaemonRevisionArn -> (string)

The ARN of the daemon revision being deployed.

createdAt -> (timestamp)

The time the daemon deployment was created.

startedAt -> (timestamp)

The time the daemon deployment started.

stoppedAt -> (timestamp)

The time the daemon deployment stopped.

finishedAt -> (timestamp)

The time the daemon deployment finished.