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

GetSpace

Displays information about the AWS re:Post Private private re:Post.

Request Syntax


GET /spaces/spaceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

spaceId

The ID of the private re:Post.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientId": "string",
   "configurationStatus": "string",
   "contentSize": number,
   "createDateTime": "string",
   "customerRoleArn": "string",
   "deleteDateTime": "string",
   "description": "string",
   "groupAdmins": [ "string" ],
   "name": "string",
   "randomDomain": "string",
   "roles": { 
      "string" : [ "string" ]
   },
   "spaceId": "string",
   "status": "string",
   "storageLimit": number,
   "tier": "string",
   "userAdmins": [ "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.

arn

The ARN of the private re:Post.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

clientId

The Identity Center identifier for the Application Instance.

Type: String

configurationStatus

The configuration status of the private re:Post.

Type: String

Valid Values: CONFIGURED | UNCONFIGURED

contentSize

The content size of the private re:Post.

Type: Long

createDateTime

The date when the private re:Post was created.

Type: Timestamp

customerRoleArn

The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

deleteDateTime

The date when the private re:Post was deleted.

Type: Timestamp

description

The description of the private re:Post.

Type: String

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

groupAdmins

This parameter has been deprecated.

The list of groups that are administrators of the private re:Post.

Type: Array of strings

name

The name of the private re:Post.

Type: String

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

randomDomain

The AWS generated subdomain of the private re:Post

Type: String

roles

A map of accessor identifiers and their roles.

Type: String to array of strings map

Valid Values: EXPERT | MODERATOR | ADMINISTRATOR | SUPPORTREQUESTOR

spaceId

The unique ID of the private re:Post.

Type: String

status

The creation or deletion status of the private re:Post.

Type: String

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

storageLimit

The storage limit of the private re:Post.

Type: Long

tier

The pricing tier of the private re:Post.

Type: String

Valid Values: BASIC | STANDARD

userAdmins

This parameter has been deprecated.

The list of users that are administrators of the private re:Post.

Type: Array of strings

userCount

The number of users that have onboarded to the private re:Post.

Type: Integer

userKMSKey

The custom AWS KMS key ARN that’s used for the AWS KMS encryption.

Type: String

vanityDomain

The custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.

Type: String

vanityDomainStatus

The approval status of the custom subdomain.

Type: String

Valid Values: PENDING | APPROVED | UNAPPROVED

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.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400