AWS re:Post Private 2022-05-13
- Client: Aws\Repostspace\RepostspaceClient
- Service ID: repostspace
- Version: 2022-05-13
This page describes the parameters and results for the operations of the AWS re:Post Private (2022-05-13), and shows how to use the Aws\Repostspace\RepostspaceClient object to call the described operations. This documentation is specific to the 2022-05-13 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateSpace ( array $params = [] )
- Creates an AWS re:Post Private private re:Post.
- DeleteSpace ( array $params = [] )
- Deletes an AWS re:Post Private private re:Post.
- DeregisterAdmin ( array $params = [] )
- Removes the user or group from the list of administrators of the private re:Post.
- GetSpace ( array $params = [] )
- Displays information about the AWS re:Post Private private re:Post.
- ListSpaces ( array $params = [] )
- Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
- ListTagsForResource ( array $params = [] )
- Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn.
- RegisterAdmin ( array $params = [] )
- Adds a user or group to the list of administrators of the private re:Post.
- SendInvites ( array $params = [] )
- Sends an invitation email to selected users and groups.
- TagResource ( array $params = [] )
- Associates tags with an AWS re:Post Private resource.
- UntagResource ( array $params = [] )
- Removes the association of the tag with the AWS re:Post Private resource.
- UpdateSpace ( array $params = [] )
- Modifies an existing AWS re:Post Private private re:Post.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateSpace
$result = $client->createSpace
([/* ... */]); $promise = $client->createSpaceAsync
([/* ... */]);
Creates an AWS re:Post Private private re:Post.
Parameter Syntax
$result = $client->createSpace([ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'roleArn' => '<string>', 'subdomain' => '<string>', // REQUIRED 'tags' => ['<string>', ...], 'tier' => 'BASIC|STANDARD', // REQUIRED 'userKMSKey' => '<string>', ]);
Parameter Details
Members
- description
-
- Type: string
A description for the private re:Post. This is used only to help you identify this private re:Post.
- name
-
- Required: Yes
- Type: string
The name for the private re:Post. This must be unique in your account.
- roleArn
-
- Type: string
The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
- subdomain
-
- Required: Yes
- Type: string
The subdomain that you use to access your AWS re:Post Private private re:Post. All custom subdomains must be approved by AWS before use. In addition to your custom subdomain, all private re:Posts are issued an AWS generated subdomain for immediate use.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The list of tags associated with the private re:Post.
- tier
-
- Required: Yes
- Type: string
The pricing tier for the private re:Post.
- userKMSKey
-
- Type: string
The AWS KMS key ARN that’s used for the AWS KMS encryption. If you don't provide a key, your data is encrypted by default with a key that AWS owns and manages for you.
Result Syntax
[ 'spaceId' => '<string>', ]
Result Details
Members
- spaceId
-
- Required: Yes
- Type: string
The unique ID of the private re:Post.
Errors
- ServiceQuotaExceededException:
Request would cause a service quota to be exceeded.
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ConflictException:
Updating or deleting a resource can cause an inconsistent state.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
DeleteSpace
$result = $client->deleteSpace
([/* ... */]); $promise = $client->deleteSpaceAsync
([/* ... */]);
Deletes an AWS re:Post Private private re:Post.
Parameter Syntax
$result = $client->deleteSpace([ 'spaceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- spaceId
-
- Required: Yes
- Type: string
The unique ID of the private re:Post.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
DeregisterAdmin
$result = $client->deregisterAdmin
([/* ... */]); $promise = $client->deregisterAdminAsync
([/* ... */]);
Removes the user or group from the list of administrators of the private re:Post.
Parameter Syntax
$result = $client->deregisterAdmin([ 'adminId' => '<string>', // REQUIRED 'spaceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- adminId
-
- Required: Yes
- Type: string
The ID of the admin to remove.
- spaceId
-
- Required: Yes
- Type: string
The ID of the private re:Post to remove the admin from.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
GetSpace
$result = $client->getSpace
([/* ... */]); $promise = $client->getSpaceAsync
([/* ... */]);
Displays information about the AWS re:Post Private private re:Post.
Parameter Syntax
$result = $client->getSpace([ 'spaceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- spaceId
-
- Required: Yes
- Type: string
The ID of the private re:Post.
Result Syntax
[ 'arn' => '<string>', 'clientId' => '<string>', 'configurationStatus' => 'CONFIGURED|UNCONFIGURED', 'contentSize' => <integer>, 'createDateTime' => <DateTime>, 'customerRoleArn' => '<string>', 'deleteDateTime' => <DateTime>, 'description' => '<string>', 'groupAdmins' => ['<string>', ...], 'name' => '<string>', 'randomDomain' => '<string>', 'spaceId' => '<string>', 'status' => '<string>', 'storageLimit' => <integer>, 'tier' => 'BASIC|STANDARD', 'userAdmins' => ['<string>', ...], 'userCount' => <integer>, 'userKMSKey' => '<string>', 'vanityDomain' => '<string>', 'vanityDomainStatus' => 'PENDING|APPROVED|UNAPPROVED', ]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the private re:Post.
- clientId
-
- Required: Yes
- Type: string
The Identity Center identifier for the Application Instance.
- configurationStatus
-
- Required: Yes
- Type: string
The configuration status of the private re:Post.
- contentSize
-
- Type: long (int|float)
The content size of the private re:Post.
- createDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the private re:Post was created.
- customerRoleArn
-
- Type: string
The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
- deleteDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the private re:Post was deleted.
- description
-
- Type: string
The description of the private re:Post.
- groupAdmins
-
- Type: Array of strings
The list of groups that are administrators of the private re:Post.
- name
-
- Required: Yes
- Type: string
The name of the private re:Post.
- randomDomain
-
- Required: Yes
- Type: string
The AWS generated subdomain of the private re:Post
- spaceId
-
- Required: Yes
- Type: string
The unique ID of the private re:Post.
- status
-
- Required: Yes
- Type: string
The creation or deletion status of the private re:Post.
- storageLimit
-
- Required: Yes
- Type: long (int|float)
The storage limit of the private re:Post.
- tier
-
- Required: Yes
- Type: string
The pricing tier of the private re:Post.
- userAdmins
-
- Type: Array of strings
The list of users that are administrators of the private re:Post.
- userCount
-
- Type: int
The number of users that have onboarded to the private re:Post.
- userKMSKey
-
- Type: string
The custom AWS KMS key ARN that’s used for the AWS KMS encryption.
- vanityDomain
-
- Required: Yes
- Type: string
The custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.
- vanityDomainStatus
-
- Required: Yes
- Type: string
The approval status of the custom subdomain.
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
ListSpaces
$result = $client->listSpaces
([/* ... */]); $promise = $client->listSpacesAsync
([/* ... */]);
Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
Parameter Syntax
$result = $client->listSpaces([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of private re:Posts to include in the results.
- nextToken
-
- Type: string
The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.
Result Syntax
[ 'nextToken' => '<string>', 'spaces' => [ [ 'arn' => '<string>', 'configurationStatus' => 'CONFIGURED|UNCONFIGURED', 'contentSize' => <integer>, 'createDateTime' => <DateTime>, 'deleteDateTime' => <DateTime>, 'description' => '<string>', 'name' => '<string>', 'randomDomain' => '<string>', 'spaceId' => '<string>', 'status' => '<string>', 'storageLimit' => <integer>, 'tier' => 'BASIC|STANDARD', 'userCount' => <integer>, 'userKMSKey' => '<string>', 'vanityDomain' => '<string>', 'vanityDomainStatus' => 'PENDING|APPROVED|UNAPPROVED', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token that you use when you request the next set of private re:Posts.
- spaces
-
- Required: Yes
- Type: Array of SpaceData structures
An array of structures that contain some information about the private re:Posts in the account.
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn. The only resource that can be tagged is a private re:Post.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that the tags are associated with.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The list of tags that are associated with the resource.
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
RegisterAdmin
$result = $client->registerAdmin
([/* ... */]); $promise = $client->registerAdminAsync
([/* ... */]);
Adds a user or group to the list of administrators of the private re:Post.
Parameter Syntax
$result = $client->registerAdmin([ 'adminId' => '<string>', // REQUIRED 'spaceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- adminId
-
- Required: Yes
- Type: string
The ID of the administrator.
- spaceId
-
- Required: Yes
- Type: string
The ID of the private re:Post.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
SendInvites
$result = $client->sendInvites
([/* ... */]); $promise = $client->sendInvitesAsync
([/* ... */]);
Sends an invitation email to selected users and groups.
Parameter Syntax
$result = $client->sendInvites([ 'accessorIds' => ['<string>', ...], // REQUIRED 'body' => '<string>', // REQUIRED 'spaceId' => '<string>', // REQUIRED 'title' => '<string>', // REQUIRED ]);
Parameter Details
Members
- accessorIds
-
- Required: Yes
- Type: Array of strings
The array of identifiers for the users and groups.
- body
-
- Required: Yes
- Type: string
The body of the invite.
- spaceId
-
- Required: Yes
- Type: string
The ID of the private re:Post.
- title
-
- Required: Yes
- Type: string
The title of the invite.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Associates tags with an AWS re:Post Private resource. Currently, the only resource that can be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is appended to the list of tags that are associated with the resource. If you specify a tag key that’s already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that the tag is associated with.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The list of tag keys and values that must be associated with the resource. You can associate tag keys only, tags (key and values) only, or a combination of tag keys and tags.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes the association of the tag with the AWS re:Post Private resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The key values of the tag.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
UpdateSpace
$result = $client->updateSpace
([/* ... */]); $promise = $client->updateSpaceAsync
([/* ... */]);
Modifies an existing AWS re:Post Private private re:Post.
Parameter Syntax
$result = $client->updateSpace([ 'description' => '<string>', 'roleArn' => '<string>', 'spaceId' => '<string>', // REQUIRED 'tier' => 'BASIC|STANDARD', ]);
Parameter Details
Members
- description
-
- Type: string
A description for the private re:Post. This is used only to help you identify this private re:Post.
- roleArn
-
- Type: string
The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
- spaceId
-
- Required: Yes
- Type: string
The unique ID of this private re:Post.
- tier
-
- Type: string
The pricing tier of this private re:Post.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
User does not have sufficient access to perform this action.
- ConflictException:
Updating or deleting a resource can cause an inconsistent state.
- ValidationException:
The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException:
Request references a resource which does not exist.
- ThrottlingException:
Request was denied due to request throttling.
- InternalServerException:
Unexpected error during processing of request.
Shapes
AccessDeniedException
Description
User does not have sufficient access to perform this action.
Members
- message
-
- Required: Yes
- Type: string
ConflictException
Description
Updating or deleting a resource can cause an inconsistent state.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The ID of the resource.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource.
InternalServerException
Description
Unexpected error during processing of request.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
Advice to clients on when the call can be safely retried.
ResourceNotFoundException
Description
Request references a resource which does not exist.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The ID of the resource.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource.
ServiceQuotaExceededException
Description
Request would cause a service quota to be exceeded.
Members
- message
-
- Required: Yes
- Type: string
- quotaCode
-
- Required: Yes
- Type: string
The code to identify the quota.
- resourceId
-
- Required: Yes
- Type: string
The id of the resource.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource.
- serviceCode
-
- Required: Yes
- Type: string
The code to identify the service.
SpaceData
Description
A structure that contains some information about a private re:Post in the account.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the private re:Post.
- configurationStatus
-
- Required: Yes
- Type: string
The configuration status of the private re:Post.
- contentSize
-
- Type: long (int|float)
The content size of the private re:Post.
- createDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the private re:Post was created.
- deleteDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date when the private re:Post was deleted.
- description
-
- Type: string
The description for the private re:Post. This is used only to help you identify this private re:Post.
- name
-
- Required: Yes
- Type: string
The name for the private re:Post.
- randomDomain
-
- Required: Yes
- Type: string
The AWS generated subdomain of the private re:Post.
- spaceId
-
- Required: Yes
- Type: string
The unique ID of the private re:Post.
- status
-
- Required: Yes
- Type: string
The creation/deletion status of the private re:Post.
- storageLimit
-
- Required: Yes
- Type: long (int|float)
The storage limit of the private re:Post.
- tier
-
- Required: Yes
- Type: string
The pricing tier of the private re:Post.
- userCount
-
- Type: int
The number of onboarded users to the private re:Post.
- userKMSKey
-
- Type: string
The custom AWS KMS key ARN that’s used for the AWS KMS encryption.
- vanityDomain
-
- Required: Yes
- Type: string
This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.
- vanityDomainStatus
-
- Required: Yes
- Type: string
This approval status of the custom subdomain.
ThrottlingException
Description
Request was denied due to request throttling.
Members
- message
-
- Required: Yes
- Type: string
- quotaCode
-
- Type: string
The code to identify the quota.
- retryAfterSeconds
-
- Type: int
Advice to clients on when the call can be safely retried.
- serviceCode
-
- Type: string
The code to identify the service.
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
The field that caused the error, if applicable.
- message
-
- Required: Yes
- Type: string
- reason
-
- Required: Yes
- Type: string
The reason why the request failed validation.
ValidationExceptionField
Description
Stores information about a field that’s passed inside a request that resulted in an exception.
Members
- message
-
- Required: Yes
- Type: string
The name of the field.
- name
-
- Required: Yes
- Type: string
Message describing why the field failed validation.