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

ListSpaces

Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.

Request Syntax


GET /spaces?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of private re:Posts to include in the results.

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

nextToken

The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "spaces": [ 
      { 
         "arn": "string",
         "configurationStatus": "string",
         "contentSize": number,
         "createDateTime": "string",
         "deleteDateTime": "string",
         "description": "string",
         "name": "string",
         "randomDomain": "string",
         "spaceId": "string",
         "status": "string",
         "storageLimit": number,
         "supportedEmailDomains": { 
            "allowedDomains": [ "string" ],
            "enabled": "string"
         },
         "tier": "string",
         "userCount": number,
         "userKMSKey": "string",
         "vanityDomain": "string",
         "vanityDomainStatus": "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

The token that you use when you request the next set of private re:Posts.

Type: String

spaces

An array of structures that contain some information about the private re:Posts in the account.

Type: Array of SpaceData objects

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

retryAfterSeconds: Advice to clients on when the call can be safely retried.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

quotaCode: The code to identify the quota.
retryAfterSeconds: Advice to clients on when the call can be safely retried.
serviceCode: The code to identify the service.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The field that caused the error, if applicable.
reason: The reason why the request failed validation.

HTTP Status Code: 400