Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetService

Returns information about a service discovered by Application Signals.

Request Syntax


POST /service?EndTime=EndTime&StartTime=StartTime HTTP/1.1 Content-type: application/json { "KeyAttributes": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

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

Your requested start time will be rounded to the nearest hour.

Required: Yes

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

Your requested start time will be rounded to the nearest hour.

Required: Yes

Request Body

The request accepts the following data in JSON format.

KeyAttributes

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, Name, and Environment 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.

Type: String to string map

Map Entries: Maximum number of 4 items.

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

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [ -~]*[!-~]+[ -~]*

Required: Yes

Response Syntax


HTTP/1.1 200 Content-type: application/json { "EndTime": number, "LogGroupReferences": [ { "string" : "string" } ], "Service": { "AttributeMaps": [ { "string" : "string" } ], "KeyAttributes": { "string" : "string" }, "LogGroupReferences": [ { "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 time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

This 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

LogGroupReferences

An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:

"Type": "AWS::Resource"
"ResourceType": "AWS::Logs::LogGroup"
"Identifier": "name-of-log-group"

Type: Array of string to string maps

Map Entries: Maximum number of 4 items.

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

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [ -~]*[!-~]+[ -~]*

Service

A structure containing information about the service.

Type: Service object

StartTime

The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057.

This 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