[ aws . ecs ]

monitor-express-gateway-service

Description

Monitors the progress of resource creation for an ECS Express Gateway Service. This command provides real-time monitoring of service deployments with interactive progress display, showing the status of load balancers, security groups, auto-scaling configurations, and other AWS resources as they are created or updated. Use --resource-view RESOURCE to view all service resources, or --resource-view DEPLOYMENT to track only resources that have changed in the most recent deployment. The command requires a terminal (TTY) to run and the monitoring session continues until manually stopped by the user or the specified timeout is reached. Use keyboard shortcuts to navigate: up/down to scroll through resources, ‘q’ to quit monitoring.

Synopsis

  monitor-express-gateway-service
--service-arn <value>
[--resource-view <value>]
[--timeout <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]

Options

--service-arn (string) [required] The short name or full Amazon Resource Name (ARN) of the service to monitor.

--resource-view (string) Specifies which resources to display during monitoring. RESOURCE (default) - Combines resources from all active configurations of the service and displays the live status of load balancers, security groups, target groups, etc. DEPLOYMENT - Determines the resources that are being added or removed as part of the latest service deployment, and displays their live statuses.

--timeout (integer) Maximum time in minutes to monitor the service. Default is 30 minutes.

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

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

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 monitor an Express Gateway Service deployment

The following monitor-express-gateway-service example monitors an Express Gateway Service deployment, showing all resources associated with the service.

aws ecs monitor-express-gateway-service --service-arn arn:aws:ecs:us-east-1:123456789012:service/my-cluster/my-express-gateway-service

This command displays an interactive monitoring interface rather than producing standard output.

For more information, see Express Gateway Service in the Amazon Elastic Container Service Developer Guide.

To monitor only resources that changed in the latest deployment

The following monitor-express-gateway-service example monitors an Express Gateway Service but only shows resources that have changed in the most recent deployment.

aws ecs monitor-express-gateway-service \
    --service-arn arn:aws:ecs:us-east-1:123456789012:service/my-cluster/my-express-gateway-service \
    --resource-view DEPLOYMENT

For more information, see Express Gateway Service in the Amazon Elastic Container Service Developer Guide.

To monitor with a custom timeout

The following monitor-express-gateway-service example monitors an Express Gateway Service with a timeout of 60 minutes instead of the default 30 minutes.

aws ecs monitor-express-gateway-service \
    --service-arn my-express-gateway-service \
    --timeout 60

The command provides an interactive display with the following controls:

• Press up / down keys to scroll up or down through the resource list
• Press q to quit the monitoring session
• Status bar shows a spinner indicating active monitoring

The command requires a terminal (TTY) and will continue monitoring until manually stopped by the user or the timeout is reached.

For more information, see Express Gateway Service in the Amazon Elastic Container Service Developer Guide.