ListServiceLevelObjectives
Returns a list of SLOs created in this account.
Request Syntax
POST /slos?IncludeLinkedAccounts=IncludeLinkedAccounts
&MaxResults=MaxResults
&NextToken=NextToken
&OperationName=OperationName
&SloOwnerAwsAccountId=SloOwnerAwsAccountId
HTTP/1.1
Content-type: application/json
{
"KeyAttributes": {
"string
" : "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- IncludeLinkedAccounts
-
To be written
- 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 50.
- NextToken
-
Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
- OperationName
-
The name of the operation that this SLO is associated with.
Length Constraints: Minimum length of 1. Maximum length of 255.
- SloOwnerAwsAccountId
-
To be written.
Pattern:
[0-9]{12}
Request Body
The request accepts the following data in JSON format.
- KeyAttributes
-
You can use this optional field to specify which services you want to retrieve SLO information for.
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 theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::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: No
-
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SloSummaries": [
{
"Arn": "string",
"CreatedTime": number,
"KeyAttributes": {
"string" : "string"
},
"Name": "string",
"OperationName": "string"
}
]
}
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.
- NextToken
-
Include this value in your next use of this API to get next set of service level objectives.
Type: String
- SloSummaries
-
An array of structures, where each structure contains information about one SLO.
Type: Array of ServiceLevelObjectiveSummary objects
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: