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

ListInstances

List all AWS Supply Chain instances for a specific account. Enables you to programmatically list all AWS Supply Chain instances based on their account ID, instance name, and state of the instance (active or delete).

Request Syntax


GET /api/instance?instanceNameFilter=instanceNameFilter&instanceStateFilter=instanceStateFilter&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

instanceNameFilter

The filter to ListInstances based on their names.

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: (?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9]

instanceStateFilter

The filter to ListInstances based on their state.

Array Members: Minimum number of 0 items. Maximum number of 6 items.

maxResults

Specify the maximum number of instances to fetch in this paginated request.

Valid Range: Minimum value of 0. Maximum value of 20.

nextToken

The pagination token to fetch the next page of instances.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "instances": [ 
      { 
         "awsAccountId": "string",
         "createdTime": number,
         "errorMessage": "string",
         "instanceDescription": "string",
         "instanceId": "string",
         "instanceName": "string",
         "kmsKeyArn": "string",
         "lastModifiedTime": number,
         "state": "string",
         "versionNumber": number,
         "webAppDnsDomain": "string"
      }
   ],
   "nextToken": "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.

instances

The list of instances resource data details.

Type: Array of Instance objects

nextToken

The pagination token to fetch the next page of instances.

Type: String

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

Errors

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

AccessDeniedException

You do not have the required privileges to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ServiceQuotaExceededException

Request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400