list-service-states¶

Description¶

Retrieves the current state information for services monitored by Application Signals. Service states include health status, recent change events, and other operational metadata.

You can filter results by time range, AWS account, and service attributes to focus on specific services or time periods. This operation supports pagination and can include data from linked accounts.

Synopsis¶

  list-service-states
--start-time <value>
--end-time <value>
[--include-linked-accounts | --no-include-linked-accounts]
[--aws-account-id <value>]
[--attribute-filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--start-time (timestamp) [required]

The start time for the service states query. Only service states from this time onward will be included. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

--end-time (timestamp) [required]

The end time for the service states query. Only service states before this time will be included. Specify the time as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

--include-linked-accounts | --no-include-linked-accounts (boolean)

Specifies whether to include service states from linked AWS accounts in the results. Set to true to include linked accounts, or false to only include the current account. Defaults to false .

--aws-account-id (string)

The AWS account ID to filter service states. If specified, only service states from this account will be returned. If not specified, service states from the current account (and linked accounts if enabled) are returned.

Constraints:

pattern: [0-9]{12}

--attribute-filters (list)

An array of attribute filters to narrow down the service states returned. Each filter specifies an attribute name and the values to match against.

Constraints:

min: 0

max: 20

(structure)

Represents a filter for service attributes. Used to narrow down results based on specific attribute names and values.

AttributeFilterName -> (string) [required]

The name of the attribute to filter on. This corresponds to service metadata attributes such as environment, team, or custom tags.

Constraints:

pattern: [A-Za-z0-9 :/-]+

AttributeFilterValues -> (list) [required]

An array of values to match against the specified attribute. Services with attribute values matching any of these values will be included in the results.

Constraints:

min: 0

max: 20

(string)

Constraints:

pattern: [A-Za-z0-9 :/-]+

Shorthand Syntax:

AttributeFilterName=string,AttributeFilterValues=string,string ...

JSON Syntax:

[
  {
    "AttributeFilterName": "string",
    "AttributeFilterValues": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

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

Output¶

StartTime -> (timestamp)

The start time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

EndTime -> (timestamp)

The end time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

ServiceStates -> (list)

An array of service state objects that match the specified criteria. Each service state includes current status, recent change events, and service metadata.

Constraints:

min: 0

max: 250

(structure)

Represents the current state and health information for a service monitored by Application Signals.

AttributeFilters -> (list)

The attribute filters that were applied when retrieving this service state.

Constraints:

min: 0

max: 20

(structure)

Represents a filter for service attributes. Used to narrow down results based on specific attribute names and values.

AttributeFilterName -> (string) [required]

The name of the attribute to filter on. This corresponds to service metadata attributes such as environment, team, or custom tags.

Constraints:

pattern: [A-Za-z0-9 :/-]+

AttributeFilterValues -> (list) [required]

An array of values to match against the specified attribute. Services with attribute values matching any of these values will be included in the results.

Constraints:

min: 0

max: 20

(string)

Constraints:

pattern: [A-Za-z0-9 :/-]+

Service -> (map) [required]

The service entity information for this service state.

Constraints:

min: 1

max: 4

key -> (string)

Constraints:

pattern: [a-zA-Z]{1,50}

value -> (string)

Constraints:

min: 1

max: 1024

pattern: [ -~]*[!-~]+[ -~]*

LatestChangeEvents -> (list) [required]

An array of the most recent change events that may have affected this service, such as deployments or configuration changes.

Constraints:

min: 1

max: 1

(structure)

Represents a change event that occurred in the system, such as deployments, configuration changes, or other operational events that may impact service performance.

Timestamp -> (timestamp) [required]

The timestamp when the change event occurred, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

AccountId -> (string) [required]

The AWS account ID where the change event occurred.

Constraints:

pattern: [0-9]{12}

Region -> (string) [required]

The AWS region where the change event occurred.

Entity -> (map) [required]

The entity or resource that was changed, such as a service, deployment, or configuration.

Constraints:

min: 1

max: 4

key -> (string)

Constraints:

pattern: [a-zA-Z]{1,50}

value -> (string)

Constraints:

min: 1

max: 1024

pattern: [ -~]*[!-~]+[ -~]*

ChangeEventType -> (string) [required]

The type of change that occurred, such as “Deployment”, “Configuration”, or “Infrastructure”.

Possible values:

DEPLOYMENT

EventId -> (string) [required]

A unique identifier for the change event.

UserName -> (string)

The name of the user or system that initiated the change event.

EventName -> (string)

A descriptive name for the change event that provides context about what changed.

NextToken -> (string)

The token to use for retrieving the next page of results. This value is present only if there are more results available than were returned in the current response.

Table of Contents

Feedback

User Guide