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

ListDomainConfigurations

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations action.

Request Syntax


GET /domainConfigurations?marker=marker&pageSize=pageSize&serviceType=serviceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

marker

The marker for the next set of results.

Length Constraints: Maximum length of 1024.

Pattern: [A-Za-z0-9+/]+={0,2}

pageSize

The result page size.

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

serviceType

The type of service delivered by the endpoint.

Valid Values: DATA | CREDENTIAL_PROVIDER | JOBS

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "domainConfigurations": [ 
      { 
         "domainConfigurationArn": "string",
         "domainConfigurationName": "string",
         "serviceType": "string"
      }
   ],
   "nextMarker": "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.

domainConfigurations

A list of objects that contain summary information about the user's domain configurations.

Type: Array of DomainConfigurationSummary objects

nextMarker

The marker for the next set of results.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [A-Za-z0-9+/]+={0,2}

Errors

InternalFailureException

An unexpected error has occurred.

message: The message for the exception.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

message: The message for the exception.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

message: The message for the exception.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

message: The message for the exception.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

message: The message for the exception.

HTTP Status Code: 401