List Service States

cloudwatchapplicationsignals_list_service_states

R Documentation

Returns information about the last deployment and other change states of services¶

Description¶

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.

Usage¶

cloudwatchapplicationsignals_list_service_states(StartTime, EndTime,
  MaxResults, NextToken, IncludeLinkedAccounts, AwsAccountId,
  AttributeFilters)

Arguments¶

StartTime

[required] 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.

EndTime

[required] 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.

MaxResults

The maximum number of service states to return in one operation. If you omit this parameter, the default of 20 is used.

NextToken

Include this value, if it was returned by the previous operation, to get the next set of service states.

IncludeLinkedAccounts

If you are using this operation in a monitoring account, specify true to include service states from source accounts in the returned data.

AwsAccountId

The Amazon Web Services account ID to filter service states by. Use this to limit results to services from a specific account.

A list of attribute filters to narrow down the services. You can filter by platform, environment, or other service attributes.

Value¶

A list with the following syntax:

list(
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  ServiceStates = list(
    list(
      AttributeFilters = list(
        list(
          AttributeFilterName = "string",
          AttributeFilterValues = list(
            "string"
          )
        )
      ),
      Service = list(
        "string"
      ),
      LatestChangeEvents = list(
        list(
          Timestamp = as.POSIXct(
            "2015-01-01"
          ),
          AccountId = "string",
          Region = "string",
          Entity = list(
            "string"
          ),
          ChangeEventType = "DEPLOYMENT"|"CONFIGURATION",
          EventId = "string",
          UserName = "string",
          EventName = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_service_states(
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NextToken = "string",
  IncludeLinkedAccounts = TRUE|FALSE,
  AwsAccountId = "string",
  AttributeFilters = list(
    list(
      AttributeFilterName = "string",
      AttributeFilterValues = list(
        "string"
      )
    )
  )
)