AWS SDK for PHP 3.x

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 */).

BatchAddChannelRoleToAccessors ( array $params = [] ): Add role to multiple users or groups in a private re:Post channel.
BatchAddRole ( array $params = [] ): Add a role to multiple users or groups in a private re:Post.
BatchRemoveChannelRoleFromAccessors ( array $params = [] ): Remove a role from multiple users or groups in a private re:Post channel.
BatchRemoveRole ( array $params = [] ): Remove a role from multiple users or groups in a private re:Post.
CreateChannel ( array $params = [] ): Creates a channel in an AWS re:Post Private private re:Post.
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.
GetChannel ( array $params = [] ): Displays information about a channel in a private re:Post.
GetSpace ( array $params = [] ): Displays information about the AWS re:Post Private private re:Post.
ListChannels ( array $params = [] ): Returns the list of channel within a private re:Post with some information about each channel.
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.
UpdateChannel ( array $params = [] ): Modifies an existing channel.
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:

ListChannels
ListSpaces

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
ChannelCreated	GetChannel	2	60
ChannelDeleted	GetChannel	2	60
SpaceCreated	GetSpace	300	24
SpaceDeleted	GetSpace	300	24

Operations

BatchAddChannelRoleToAccessors

$result = $client->batchAddChannelRoleToAccessors([/* ... */]);
$promise = $client->batchAddChannelRoleToAccessorsAsync([/* ... */]);

Add role to multiple users or groups in a private re:Post channel.

Parameter Syntax

$result = $client->batchAddChannelRoleToAccessors([
    'accessorIds' => ['<string>', ...], // REQUIRED
    'channelId' => '<string>', // REQUIRED
    'channelRole' => 'ASKER|EXPERT|MODERATOR|SUPPORTREQUESTOR', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

accessorIds

: Required: Yes
: Type: Array of strings

The user or group identifiers to add the role to.

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

channelRole

: Required: Yes
: Type: string

The channel role to add to the users or groups.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'addedAccessorIds' => ['<string>', ...],
    'errors' => [
        [
            'accessorId' => '<string>',
            'error' => <integer>,
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

addedAccessorIds

: Required: Yes
: Type: Array of strings

An array of successfully updated identifiers.

errors

: Required: Yes
: Type: Array of BatchError structures

An array of errors that occurred when roles were added.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: BatchAddChannelRoleToAccessors

$result = $client->batchAddChannelRoleToAccessors([
    'accessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
    'channelId' => 'WS1234567890abcdefghijkl',
    'channelRole' => 'MODERATOR',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'errors' => [
    ],
    'addedAccessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
]

BatchAddRole

$result = $client->batchAddRole([/* ... */]);
$promise = $client->batchAddRoleAsync([/* ... */]);

Add a role to multiple users or groups in a private re:Post.

Parameter Syntax

$result = $client->batchAddRole([
    'accessorIds' => ['<string>', ...], // REQUIRED
    'role' => 'EXPERT|MODERATOR|ADMINISTRATOR|SUPPORTREQUESTOR', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

accessorIds

: Required: Yes
: Type: Array of strings

The user or group accessor identifiers to add the role to.

role

: Required: Yes
: Type: string

The role to add to the users or groups.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'addedAccessorIds' => ['<string>', ...],
    'errors' => [
        [
            'accessorId' => '<string>',
            'error' => <integer>,
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

addedAccessorIds

: Required: Yes
: Type: Array of strings

An array of successfully updated accessor identifiers.

errors

: Required: Yes
: Type: Array of BatchError structures

An array of errors that occurred when roles were added.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: BatchAddRole

$result = $client->batchAddRole([
    'accessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
    'role' => 'EXPERT',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'errors' => [
    ],
    'addedAccessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
]

BatchRemoveChannelRoleFromAccessors

$result = $client->batchRemoveChannelRoleFromAccessors([/* ... */]);
$promise = $client->batchRemoveChannelRoleFromAccessorsAsync([/* ... */]);

Remove a role from multiple users or groups in a private re:Post channel.

Parameter Syntax

$result = $client->batchRemoveChannelRoleFromAccessors([
    'accessorIds' => ['<string>', ...], // REQUIRED
    'channelId' => '<string>', // REQUIRED
    'channelRole' => 'ASKER|EXPERT|MODERATOR|SUPPORTREQUESTOR', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

accessorIds

: Required: Yes
: Type: Array of strings

The users or groups identifiers to remove the role from.

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

channelRole

: Required: Yes
: Type: string

The channel role to remove from the users or groups.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'errors' => [
        [
            'accessorId' => '<string>',
            'error' => <integer>,
            'message' => '<string>',
        ],
        // ...
    ],
    'removedAccessorIds' => ['<string>', ...],
]

Result Details

Members

errors

: Required: Yes
: Type: Array of BatchError structures

An array of errors that occurred when roles were removed.

removedAccessorIds

: Required: Yes
: Type: Array of strings

An array of successfully updated identifiers.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: BatchRemoveChannelRoleFromAccessors

$result = $client->batchRemoveChannelRoleFromAccessors([
    'accessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
    'channelId' => 'WS1234567890abcdefghijkl',
    'channelRole' => 'MODERATOR',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'errors' => [
    ],
    'removedAccessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
]

BatchRemoveRole

$result = $client->batchRemoveRole([/* ... */]);
$promise = $client->batchRemoveRoleAsync([/* ... */]);

Remove a role from multiple users or groups in a private re:Post.

Parameter Syntax

$result = $client->batchRemoveRole([
    'accessorIds' => ['<string>', ...], // REQUIRED
    'role' => 'EXPERT|MODERATOR|ADMINISTRATOR|SUPPORTREQUESTOR', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

accessorIds

: Required: Yes
: Type: Array of strings

The user or group accessor identifiers to remove the role from.

role

: Required: Yes
: Type: string

The role to remove from the users or groups.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'errors' => [
        [
            'accessorId' => '<string>',
            'error' => <integer>,
            'message' => '<string>',
        ],
        // ...
    ],
    'removedAccessorIds' => ['<string>', ...],
]

Result Details

Members

errors

: Required: Yes
: Type: Array of BatchError structures

An array of errors that occurred when roles were removed.

removedAccessorIds

: Required: Yes
: Type: Array of strings

An array of successfully updated accessor identifiers.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: BatchRemoveRole

$result = $client->batchRemoveRole([
    'accessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
    'role' => 'EXPERT',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'errors' => [
    ],
    'removedAccessorIds' => [
        '12345678-1234-1234-1234-1234567890ab',
    ],
]

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Creates a channel in an AWS re:Post Private private re:Post.

Parameter Syntax

$result = $client->createChannel([
    'channelDescription' => '<string>',
    'channelName' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelDescription

: Type: string

A description for the channel. This is used only to help you identify this channel.

channelName

: Required: Yes
: Type: string

The name for the channel. This must be unique per private re:Post.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'channelId' => '<string>',
]

Result Details

Members

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

Errors

ServiceQuotaExceededException:: Request would cause a service quota to be exceeded.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: CreateChannel

$result = $client->createChannel([
    'channelDescription' => 'Useful channel description',
    'channelName' => 'My First Channel',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'channelId' => 'WS1234567890abcdefghijkl',
]

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
    'supportedEmailDomains' => [
        'allowedDomains' => ['<string>', ...],
        'enabled' => 'ENABLED|DISABLED',
    ],
    '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.

supportedEmailDomains

: Type: SupportedEmailDomainsParameters structure

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.
ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
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

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
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

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

GetChannel

$result = $client->getChannel([/* ... */]);
$promise = $client->getChannelAsync([/* ... */]);

Displays information about a channel in a private re:Post.

Parameter Syntax

$result = $client->getChannel([
    'channelId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'channelDescription' => '<string>',
    'channelId' => '<string>',
    'channelName' => '<string>',
    'channelRoles' => [
        '<AccessorId>' => ['<string>', ...],
        // ...
    ],
    'channelStatus' => 'CREATED|CREATING|CREATE_FAILED|DELETED|DELETING|DELETE_FAILED',
    'createDateTime' => <DateTime>,
    'deleteDateTime' => <DateTime>,
    'spaceId' => '<string>',
]

Result Details

Members

channelDescription

: Type: string

A description for the channel. This is used only to help you identify this channel.

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

channelName

: Required: Yes
: Type: string

The name for the channel. This must be unique per private re:Post.

channelRoles

: Type: Associative array of custom strings keys (AccessorId) to stringss

The channel roles associated to the users and groups of the channel.

channelStatus

: Required: Yes
: Type: string

The status pf the channel.

createDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the channel was created.

deleteDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the channel was deleted.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: GetChannel

$result = $client->getChannel([
    'channelId' => 'WS1234567890abcdefghijkl',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'channelDescription' => 'Useful channel description',
    'channelId' => 'WS1234567890abcdefghijkl',
    'channelName' => 'My First Channel',
    'channelRoles' => [
        '12345678-1234-1234-1234-1234567890ab' => [
            'ASKER',
        ],
    ],
    'channelStatus' => 'CREATED',
    'createDateTime' => ,
    'spaceId' => 'SP1234567890abcdefghijkl',
]

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

[
    'applicationArn' => '<string>',
    'arn' => '<string>',
    'clientId' => '<string>',
    'configurationStatus' => 'CONFIGURED|UNCONFIGURED',
    'contentSize' => <integer>,
    'createDateTime' => <DateTime>,
    'customerRoleArn' => '<string>',
    'deleteDateTime' => <DateTime>,
    'description' => '<string>',
    'groupAdmins' => ['<string>', ...],
    'identityStoreId' => '<string>',
    'name' => '<string>',
    'randomDomain' => '<string>',
    'roles' => [
        '<AccessorId>' => ['<string>', ...],
        // ...
    ],
    'spaceId' => '<string>',
    'status' => '<string>',
    'storageLimit' => <integer>,
    'supportedEmailDomains' => [
        'allowedDomains' => ['<string>', ...],
        'enabled' => 'ENABLED|DISABLED|NOT_ALLOWED',
    ],
    'tier' => 'BASIC|STANDARD',
    'userAdmins' => ['<string>', ...],
    'userCount' => <integer>,
    'userKMSKey' => '<string>',
    'vanityDomain' => '<string>',
    'vanityDomainStatus' => 'PENDING|APPROVED|UNAPPROVED',
]

Result Details

Members

applicationArn

: Type: string

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.

identityStoreId

: Type: string

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

roles

: Type: Associative array of custom strings keys (AccessorId) to stringss

A map of accessor identifiers and their roles.

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.

supportedEmailDomains

: Type: SupportedEmailDomainsStatus structure

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

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Returns the list of channel within a private re:Post with some information about each channel.

Parameter Syntax

$result = $client->listChannels([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of channels to include in the results.

nextToken

: Type: string

The token for the next set of channel to return. You receive this token from a previous ListChannels operation.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[
    'channels' => [
        [
            'channelDescription' => '<string>',
            'channelId' => '<string>',
            'channelName' => '<string>',
            'channelStatus' => 'CREATED|CREATING|CREATE_FAILED|DELETED|DELETING|DELETE_FAILED',
            'createDateTime' => <DateTime>,
            'deleteDateTime' => <DateTime>,
            'groupCount' => <integer>,
            'spaceId' => '<string>',
            'userCount' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

channels

: Required: Yes
: Type: Array of ChannelData structures

An array of structures that contain some information about the channels in the private re:Post.

nextToken

: Type: string

The token that you use when you request the next set of channels.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: ListChannels

$result = $client->listChannels([
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

Result syntax:

[
    'channels' => [
        [
            'channelDescription' => 'Useful channel description',
            'channelId' => 'WS1234567890abcdefghijkl',
            'channelName' => 'My First Channel',
            'channelStatus' => 'CREATED',
            'createDateTime' => ,
            'groupCount' => 1,
            'spaceId' => 'SP1234567890abcdefghijkl',
            'userCount' => 5,
        ],
        [
            'channelDescription' => 'Better channel description',
            'channelId' => 'WSabcdefghijkl1234567890',
            'channelName' => 'Better Channel',
            'channelStatus' => 'CREATED',
            'createDateTime' => ,
            'groupCount' => 0,
            'spaceId' => 'SP1234567890abcdefghijkl',
            'userCount' => 1,
        ],
    ],
]

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>,
            'supportedEmailDomains' => [
                'allowedDomains' => ['<string>', ...],
                'enabled' => 'ENABLED|DISABLED|NOT_ALLOWED',
            ],
            '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

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
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

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
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

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
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

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ThrottlingException:: Request was denied due to request throttling.
ResourceNotFoundException:: Request references a resource which does not exist.
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

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
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

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

UpdateChannel

$result = $client->updateChannel([/* ... */]);
$promise = $client->updateChannelAsync([/* ... */]);

Modifies an existing channel.

Parameter Syntax

$result = $client->updateChannel([
    'channelDescription' => '<string>',
    'channelId' => '<string>', // REQUIRED
    'channelName' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelDescription

: Type: string

A description for the channel. This is used only to help you identify this channel.

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

channelName

: Required: Yes
: Type: string

The name for the channel. This must be unique per private re:Post.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
ResourceNotFoundException:: Request references a resource which does not exist.
ThrottlingException:: Request was denied due to request throttling.
InternalServerException:: Unexpected error during processing of request.

Examples

Example 1: UpdateChannel

$result = $client->updateChannel([
    'channelDescription' => 'Better channel description',
    'channelId' => 'WS1234567890abcdefghijkl',
    'channelName' => 'Better Channel',
    'spaceId' => 'SP1234567890abcdefghijkl',
]);

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
    'supportedEmailDomains' => [
        'allowedDomains' => ['<string>', ...],
        'enabled' => 'ENABLED|DISABLED',
    ],
    '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.

supportedEmailDomains

: Type: SupportedEmailDomainsParameters structure

tier

: Type: string

The pricing tier of this private re:Post.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: The input fails to satisfy the constraints specified by an AWS service.
AccessDeniedException:: User does not have sufficient access to perform this action.
ConflictException:: Updating or deleting a resource can cause an inconsistent state.
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

BatchError

Description

An error that occurred during a batch operation.

Members

accessorId

: Required: Yes
: Type: string

The accessor identifier that's related to the error.

error

: Required: Yes
: Type: int

The error code.

message

: Required: Yes
: Type: string

Description of the error.

ChannelData

Description

A structure that contains some information about a channel in a private re:Post.

Members

channelDescription

: Type: string

A description for the channel. This is used only to help you identify this channel.

channelId

: Required: Yes
: Type: string

The unique ID of the private re:Post channel.

channelName

: Required: Yes
: Type: string

The name for the channel. This must be unique per private re:Post.

channelStatus

: Required: Yes
: Type: string

The status pf the channel.

createDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the channel was created.

deleteDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date when the channel was deleted.

groupCount

: Required: Yes
: Type: int

The number of groups that are part of the channel.

spaceId

: Required: Yes
: Type: string

The unique ID of the private re:Post.

userCount

: Required: Yes
: Type: int

The number of users that are part of the channel.

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.

supportedEmailDomains

: Type: SupportedEmailDomainsStatus structure

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.

SupportedEmailDomainsParameters

Description

Members

allowedDomains

: Type: Array of strings

enabled

: Type: string

SupportedEmailDomainsStatus

Description

Members

allowedDomains

: Type: Array of strings

enabled

: Type: string

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.

AWS re:Post Private 2022-05-13

Operation Summary

Paginators

Waiters

Operations

BatchAddChannelRoleToAccessors

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: BatchAddChannelRoleToAccessors

BatchAddRole

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: BatchAddRole

BatchRemoveChannelRoleFromAccessors

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: BatchRemoveChannelRoleFromAccessors

BatchRemoveRole

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: BatchRemoveRole

CreateChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: CreateChannel

CreateSpace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteSpace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeregisterAdmin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetChannel

Parameter Syntax

Parameter Details