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

ListConfigurations

Returns configurations deployed by Quick Setup in the requesting AWS account and AWS Region.

Request Syntax


POST /listConfigurations HTTP/1.1
Content-type: application/json

{
   "ConfigurationDefinitionId": "string",
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "ManagerArn": "string",
   "MaxItems": number,
   "StartingToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ConfigurationDefinitionId

The ID of the configuration definition.

Type: String

Pattern: ^[a-z0-9-]{1,20}$

Required: No

Filters

Filters the results returned by the request.

Type: Array of Filter objects

Required: No

ManagerArn

The ARN of the configuration manager.

Type: String

Pattern: ^arn:aws:ssm-quicksetup:([^:]+):(\d{12}):configuration-manager/[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

Required: No

MaxItems

Specifies the maximum number of configurations that are returned by the request.

Type: Integer

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

Required: No

StartingToken

The token to use when requesting a specific set of items from a list.

Type: String

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

Pattern: ^[A-Za-z0-9+=@_|\/\s-]*$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationsList": [ 
      { 
         "Account": "string",
         "ConfigurationDefinitionId": "string",
         "CreatedAt": "string",
         "FirstClassParameters": { 
            "string" : "string" 
         },
         "Id": "string",
         "ManagerArn": "string",
         "Region": "string",
         "StatusSummaries": [ 
            { 
               "LastUpdatedAt": "string",
               "Status": "string",
               "StatusDetails": { 
                  "string" : "string" 
               },
               "StatusMessage": "string",
               "StatusType": "string"
            }
         ],
         "Type": "string",
         "TypeVersion": "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.

ConfigurationsList

An array of configurations.

Type: Array of ConfigurationSummary objects

NextToken

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String

Errors

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

AccessDeniedException

The requester has insufficient permissions to perform the operation.

HTTP Status Code: 403

InternalServerException

An error occurred on the server side.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found. Check the ID or name and try again.

HTTP Status Code: 404

ThrottlingException

The request or operation exceeds the maximum allowed request rate per AWS account and AWS Region.

HTTP Status Code: 429

ValidationException

The request is invalid. Verify the values provided for the request parameters are accurate.

HTTP Status Code: 400