ListServices
Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
Request Syntax
GET /services?AwsAccountId=AwsAccountId&EndTime=EndTime&IncludeLinkedAccounts=IncludeLinkedAccounts&MaxResults=MaxResults&NextToken=NextToken&StartTime=StartTime HTTP/1.1 URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
AWS Account ID.
Pattern:
[0-9]{12} - EndTime
-
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057Your requested start time will be rounded to the nearest hour.
Required: Yes
- IncludeLinkedAccounts
-
If you are using this operation in a monitoring account, specify
trueto include services from source accounts in the returned data. - MaxResults
-
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
Include this value, if it was returned by the previous operation, to get the next set of services.
- StartTime
-
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057Your requested start time will be rounded to the nearest hour.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200 Content-type: application/json { "EndTime": number, "NextToken": "string", "ServiceSummaries": [ { "AttributeMaps": [ { "string" : "string" } ], "KeyAttributes": { "string" : "string" }, "MetricReferences": [ { "AccountId": "string", "Dimensions": [ { "Name": "string", "Value": "string" } ], "MetricName": "string", "MetricType": "string", "Namespace": "string" } ], "ServiceGroups": [ { "GroupIdentifier": "string", "GroupName": "string", "GroupSource": "string", "GroupValue": "string" } ] } ], "StartTime": number }Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EndTime
-
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Type: Timestamp
- NextToken
-
Include this value in your next use of this API to get next set of services.
Type: String
- ServiceSummaries
-
An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.
Type: Array of ServiceSummary objects
- StartTime
-
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- ThrottlingException
-
The request was throttled because of quota limits.
HTTP Status Code: 429
- ValidationException
-
The resource is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: