AWS cli documentation change
Summary
Updated command documentation to clarify functionality, parameters, and response format. Changes include revised descriptions of time parameters (switching from milliseconds to seconds epoch time), cross-account monitoring behavior, attribute filters, and enhanced details about service state change events including CloudTrail integration examples.
Security assessment
The changes primarily improve documentation clarity and accuracy without addressing specific security vulnerabilities. While the update adds visibility into change events (including CloudTrail references) which could aid security monitoring, there's no evidence of patching vulnerabilities or addressing security incidents. Parameter changes focus on API usage clarification rather than security controls.
Diff
diff --git a/cli/latest/reference/application-signals/list-service-states.md b/cli/latest/reference/application-signals/list-service-states.md index 80b5389f0..4888fcacf 100644 --- a//cli/latest/reference/application-signals/list-service-states.md +++ b//cli/latest/reference/application-signals/list-service-states.md @@ -15 +15 @@ - * [AWS CLI 2.31.39 Command Reference](../../index.html) » + * [AWS CLI 2.32.3 Command Reference](../../index.html) » @@ -59,3 +59 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -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. +Returns information about the last deployment and other change states of services. This API provides visibility into recent changes that may have affected service performance, helping with troubleshooting and change correlation. @@ -105 +103 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic -> 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. +> The start of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, `1698778057` . @@ -109 +107 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic -> 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. +> The end of the time period to retrieve service state information for. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, `1698778057` . @@ -113 +111 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic -> 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` . +> If you are using this operation in a monitoring account, specify `true` to include service states from source accounts in the returned data. @@ -117 +115 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic -> 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. +> The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account. @@ -127 +125 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic -> An array of attribute filters to narrow down the service states returned. Each filter specifies an attribute name and the values to match against. +> A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes. @@ -138 +136 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic ->> Represents a filter for service attributes. Used to narrow down results based on specific attribute names and values. +>> A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics. @@ -142 +140 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic ->>> The name of the attribute to filter on. This corresponds to service metadata attributes such as environment, team, or custom tags. +>>> The name of the attribute to filter by, such as `Platform` , `Environment` , or `BusinessUnit` . @@ -152 +150 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/applic ->>> 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. +>>> An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results. @@ -306 +304 @@ StartTime -> (timestamp) -> The start time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC. +> The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, `1698778057` . @@ -310 +308 @@ EndTime -> (timestamp) -> The end time of the query range, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC. +> The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. For example, `1698778057` . @@ -314 +312 @@ 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. +> An array of structures, where each structure contains information about the state of one service, including its latest change events such as deployments. @@ -325 +323 @@ ServiceStates -> (list) ->> Represents the current state and health information for a service monitored by Application Signals. +>> A structure that contains information about the current state of a service, including its latest change events such as deployments and other state-changing activities. @@ -329 +327 @@ ServiceStates -> (list) ->>> The attribute filters that were applied when retrieving this service state. +>>> The attribute filters that were applied when retrieving this service state information. @@ -340 +338 @@ ServiceStates -> (list) ->>>> Represents a filter for service attributes. Used to narrow down results based on specific attribute names and values. +>>>> A structure that defines a filter for narrowing down results based on specific attribute values. This can be used to filter services by platform, environment, or other service characteristics. @@ -344 +342 @@ ServiceStates -> (list) ->>>>> The name of the attribute to filter on. This corresponds to service metadata attributes such as environment, team, or custom tags. +>>>>> The name of the attribute to filter by, such as `Platform` , `Environment` , or `BusinessUnit` . @@ -354 +352 @@ ServiceStates -> (list) ->>>>> 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. +>>>>> An array of values to match for the specified attribute. Services that have any of these values for the attribute will be included in the results. @@ -373 +371 @@ ServiceStates -> (list) ->>> The service entity information for this service state. +>>> The key attributes that identify this service, including Type, Name, and Environment information. @@ -402 +400 @@ ServiceStates -> (list) ->>> An array of the most recent change events that may have affected this service, such as deployments or configuration changes. +>>> An array containing the most recent change events for this service, such as deployments, with information about when they occurred and who initiated them. @@ -413 +411 @@ ServiceStates -> (list) ->>>> Represents a change event that occurred in the system, such as deployments, configuration changes, or other operational events that may impact service performance. +>>>> A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change. @@ -417 +415 @@ ServiceStates -> (list) ->>>>> The timestamp when the change event occurred, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC. +>>>>> The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds. @@ -421 +419 @@ ServiceStates -> (list) ->>>>> The AWS account ID where the change event occurred. +>>>>> The Amazon Web Services account ID where this change event occurred. @@ -431 +429 @@ ServiceStates -> (list) ->>>>> The AWS region where the change event occurred. +>>>>> The Amazon Web Services region where this change event occurred. @@ -435 +433,20 @@ ServiceStates -> (list) ->>>>> The entity or resource that was changed, such as a service, deployment, or configuration. +>>>>> The entity (service or resource) that was affected by this change event, including its key attributes. +>>>>> +>>>>> This is a string-to-string map. It can include the following fields. +>>>>> +>>>>> * `Type` designates the type of object this is. +>>>>> * `ResourceType` specifies the type of the resource. This field is used only when the value of the `Type` field is `Resource` or `AWS::Resource` . +>>>>> * `Name` specifies the name of the object. This is used only if the value of the `Type` field is `Service` , `RemoteService` , or `AWS::Service` . +>>>>> * `Identifier` identifies the resource objects of this resource. This is used only if the value of the `Type` field is `Resource` or `AWS::Resource` . +>>>>> * `Environment` specifies the location where this object is hosted, or what it belongs to. +>>>>> * `AwsAccountId` specifies the account where this object is in. +>>>>> + +>>>>> +>>>>> Below is an example of a service. +>>>>> +>>>>>> `{ "Type": "Service", "Name": "visits-service", "Environment": "petclinic-test" }` +>>>>> +>>>>> Below is an example of a resource. +>>>>> +>>>>>> `{ "Type": "AWS::Resource", "ResourceType": "AWS::DynamoDB::Table", "Identifier": "Customers" }` @@ -464 +481 @@ ServiceStates -> (list) ->>>>> The type of change that occurred, such as “Deployment”, “Configuration”, or “Infrastructure”. +>>>>> The type of change event that occurred, such as `DEPLOYMENT` . @@ -468,0 +486 @@ ServiceStates -> (list) +>>>>> * `CONFIGURATION` @@ -474 +492 @@ ServiceStates -> (list) ->>>>> A unique identifier for the change event. +>>>>> A unique identifier for this change event. For CloudTrail-based events, this is the CloudTrail event id. For other events, this will be `Unknown` . @@ -478 +496 @@ ServiceStates -> (list) ->>>>> The name of the user or system that initiated the change event. +>>>>> The name of the user who initiated this change event, if available. @@ -482 +500 @@ ServiceStates -> (list) ->>>>> A descriptive name for the change event that provides context about what changed. +>>>>> The name or description of this change event. @@ -486 +504 @@ 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. +> Include this value in your next use of this API to get the next set of service states. @@ -498 +516 @@ NextToken -> (string) - * [AWS CLI 2.31.39 Command Reference](../../index.html) » + * [AWS CLI 2.32.3 Command Reference](../../index.html) »