Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListServiceInstances

List service instances with summary data. This action lists service instances of all services in the AWS account.

Request Syntax


{
   "filters": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "serviceName": "string",
   "sortBy": "string",
   "sortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

filters

An array of filtering criteria that scope down the result list. By default, all service instances in the AWS account are returned.

Type: Array of ListServiceInstancesFilter objects

Required: No

maxResults

The maximum number of service instances to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Type: String

Pattern: ^[A-Za-z0-9+=/]+$

Required: No

serviceName

The name of the service that the service instance belongs to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: No

sortBy

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Type: String

Required: No

sortOrder

Result list sort order.

Default: ASCENDING

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax


{
   "nextToken": "string",
   "serviceInstances": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "deploymentStatus": "string",
         "deploymentStatusMessage": "string",
         "environmentName": "string",
         "lastAttemptedDeploymentId": "string",
         "lastDeploymentAttemptedAt": number,
         "lastDeploymentSucceededAt": number,
         "lastSucceededDeploymentId": "string",
         "name": "string",
         "serviceName": "string",
         "templateMajorVersion": "string",
         "templateMinorVersion": "string",
         "templateName": "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

A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.

Type: String

Pattern: ^[A-Za-z0-9+=/]+$

serviceInstances

An array of service instances with summary data.

Type: Array of ServiceInstanceSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400