2025/07/15 - AWS re:Post Private - 6 new 4 updated api methods
Changes This release introduces Channels functionality with CreateChannel, GetChannel, ListChannels, and UpdateChannel operations. Channels provide dedicated collaboration spaces where teams can organize discussions and knowledge by projects, business units, or areas of responsibility.
Creates a channel in an AWS re:Post Private private re:Post.
See also: AWS API Documentation
Request Syntax
client.create_channel(
spaceId='string',
channelName='string',
channelDescription='string'
)
string
[REQUIRED]
The unique ID of the private re:Post.
string
[REQUIRED]
The name for the channel. This must be unique per private re:Post.
string
A description for the channel. This is used only to help you identify this channel.
dict
Response Syntax
{
'channelId': 'string'
}
Response Structure
(dict) --
channelId (string) --
The unique ID of the private re:Post channel.
Remove a role from multiple users or groups in a private re:Post channel.
See also: AWS API Documentation
Request Syntax
client.batch_remove_channel_role_from_accessors(
spaceId='string',
channelId='string',
accessorIds=[
'string',
],
channelRole='ASKER'|'EXPERT'|'MODERATOR'|'SUPPORTREQUESTOR'
)
string
[REQUIRED]
The unique ID of the private re:Post.
string
[REQUIRED]
The unique ID of the private re:Post channel.
list
[REQUIRED]
The users or groups identifiers to remove the role from.
(string) --
string
[REQUIRED]
The channel role to remove from the users or groups.
dict
Response Syntax
{
'removedAccessorIds': [
'string',
],
'errors': [
{
'accessorId': 'string',
'error': 123,
'message': 'string'
},
]
}
Response Structure
(dict) --
removedAccessorIds (list) --
An array of successfully updated identifiers.
(string) --
errors (list) --
An array of errors that occurred when roles were removed.
(dict) --
An error that occurred during a batch operation.
accessorId (string) --
The accessor identifier that's related to the error.
error (integer) --
The error code.
message (string) --
Description of the error.
Displays information about a channel in a private re:Post.
See also: AWS API Documentation
Request Syntax
client.get_channel(
spaceId='string',
channelId='string'
)
string
[REQUIRED]
The unique ID of the private re:Post.
string
[REQUIRED]
The unique ID of the private re:Post channel.
dict
Response Syntax
{
'spaceId': 'string',
'channelId': 'string',
'channelName': 'string',
'channelDescription': 'string',
'createDateTime': datetime(2015, 1, 1),
'deleteDateTime': datetime(2015, 1, 1),
'channelRoles': {
'string': [
'ASKER'|'EXPERT'|'MODERATOR'|'SUPPORTREQUESTOR',
]
},
'channelStatus': 'CREATED'|'CREATING'|'CREATE_FAILED'|'DELETED'|'DELETING'|'DELETE_FAILED'
}
Response Structure
(dict) --
spaceId (string) --
The unique ID of the private re:Post.
channelId (string) --
The unique ID of the private re:Post channel.
channelName (string) --
The name for the channel. This must be unique per private re:Post.
channelDescription (string) --
A description for the channel. This is used only to help you identify this channel.
createDateTime (datetime) --
The date when the channel was created.
deleteDateTime (datetime) --
The date when the channel was deleted.
channelRoles (dict) --
The channel roles associated to the users and groups of the channel.
(string) --
(list) --
(string) --
channelStatus (string) --
The status pf the channel.
Returns the list of channel within a private re:Post with some information about each channel.
See also: AWS API Documentation
Request Syntax
client.list_channels(
spaceId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique ID of the private re:Post.
string
The token for the next set of channel to return. You receive this token from a previous ListChannels operation.
integer
The maximum number of channels to include in the results.
dict
Response Syntax
{
'channels': [
{
'spaceId': 'string',
'channelId': 'string',
'channelName': 'string',
'channelDescription': 'string',
'createDateTime': datetime(2015, 1, 1),
'deleteDateTime': datetime(2015, 1, 1),
'channelStatus': 'CREATED'|'CREATING'|'CREATE_FAILED'|'DELETED'|'DELETING'|'DELETE_FAILED',
'userCount': 123,
'groupCount': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
channels (list) --
An array of structures that contain some information about the channels in the private re:Post.
(dict) --
A structure that contains some information about a channel in a private re:Post.
spaceId (string) --
The unique ID of the private re:Post.
channelId (string) --
The unique ID of the private re:Post channel.
channelName (string) --
The name for the channel. This must be unique per private re:Post.
channelDescription (string) --
A description for the channel. This is used only to help you identify this channel.
createDateTime (datetime) --
The date when the channel was created.
deleteDateTime (datetime) --
The date when the channel was deleted.
channelStatus (string) --
The status pf the channel.
userCount (integer) --
The number of users that are part of the channel.
groupCount (integer) --
The number of groups that are part of the channel.
nextToken (string) --
The token that you use when you request the next set of channels.
Modifies an existing channel.
See also: AWS API Documentation
Request Syntax
client.update_channel(
spaceId='string',
channelId='string',
channelName='string',
channelDescription='string'
)
string
[REQUIRED]
The unique ID of the private re:Post.
string
[REQUIRED]
The unique ID of the private re:Post channel.
string
[REQUIRED]
The name for the channel. This must be unique per private re:Post.
string
A description for the channel. This is used only to help you identify this channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Add role to multiple users or groups in a private re:Post channel.
See also: AWS API Documentation
Request Syntax
client.batch_add_channel_role_to_accessors(
spaceId='string',
channelId='string',
accessorIds=[
'string',
],
channelRole='ASKER'|'EXPERT'|'MODERATOR'|'SUPPORTREQUESTOR'
)
string
[REQUIRED]
The unique ID of the private re:Post.
string
[REQUIRED]
The unique ID of the private re:Post channel.
list
[REQUIRED]
The user or group identifiers to add the role to.
(string) --
string
[REQUIRED]
The channel role to add to the users or groups.
dict
Response Syntax
{
'addedAccessorIds': [
'string',
],
'errors': [
{
'accessorId': 'string',
'error': 123,
'message': 'string'
},
]
}
Response Structure
(dict) --
addedAccessorIds (list) --
An array of successfully updated identifiers.
(string) --
errors (list) --
An array of errors that occurred when roles were added.
(dict) --
An error that occurred during a batch operation.
accessorId (string) --
The accessor identifier that's related to the error.
error (integer) --
The error code.
message (string) --
Description of the error.
{'supportedEmailDomains': {'allowedDomains': ['string'],
'enabled': 'ENABLED | DISABLED'}}
Creates an AWS re:Post Private private re:Post.
See also: AWS API Documentation
Request Syntax
client.create_space(
name='string',
subdomain='string',
tier='BASIC'|'STANDARD',
description='string',
userKMSKey='string',
tags={
'string': 'string'
},
roleArn='string',
supportedEmailDomains={
'enabled': 'ENABLED'|'DISABLED',
'allowedDomains': [
'string',
]
}
)
string
[REQUIRED]
The name for the private re:Post. This must be unique in your account.
string
[REQUIRED]
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.
string
[REQUIRED]
The pricing tier for the private re:Post.
string
A description for the private re:Post. This is used only to help you identify this private re:Post.
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.
dict
The list of tags associated with the private re:Post.
(string) --
(string) --
string
The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
dict
enabled (string) --
allowedDomains (list) --
(string) --
dict
Response Syntax
{
'spaceId': 'string'
}
Response Structure
(dict) --
spaceId (string) --
The unique ID of the private re:Post.
{'applicationArn': 'string',
'identityStoreId': 'string',
'supportedEmailDomains': {'allowedDomains': ['string'],
'enabled': 'ENABLED | DISABLED | NOT_ALLOWED'}}
Displays information about the AWS re:Post Private private re:Post.
See also: AWS API Documentation
Request Syntax
client.get_space(
spaceId='string'
)
string
[REQUIRED]
The ID of the private re:Post.
dict
Response Syntax
{
'spaceId': 'string',
'arn': 'string',
'name': 'string',
'status': 'string',
'configurationStatus': 'CONFIGURED'|'UNCONFIGURED',
'clientId': 'string',
'identityStoreId': 'string',
'applicationArn': 'string',
'description': 'string',
'vanityDomainStatus': 'PENDING'|'APPROVED'|'UNAPPROVED',
'vanityDomain': 'string',
'randomDomain': 'string',
'customerRoleArn': 'string',
'createDateTime': datetime(2015, 1, 1),
'deleteDateTime': datetime(2015, 1, 1),
'tier': 'BASIC'|'STANDARD',
'storageLimit': 123,
'userAdmins': [
'string',
],
'groupAdmins': [
'string',
],
'roles': {
'string': [
'EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR',
]
},
'userKMSKey': 'string',
'userCount': 123,
'contentSize': 123,
'supportedEmailDomains': {
'enabled': 'ENABLED'|'DISABLED'|'NOT_ALLOWED',
'allowedDomains': [
'string',
]
}
}
Response Structure
(dict) --
spaceId (string) --
The unique ID of the private re:Post.
arn (string) --
The ARN of the private re:Post.
name (string) --
The name of the private re:Post.
status (string) --
The creation or deletion status of the private re:Post.
configurationStatus (string) --
The configuration status of the private re:Post.
clientId (string) --
The Identity Center identifier for the Application Instance.
identityStoreId (string) --
applicationArn (string) --
description (string) --
The description of the private re:Post.
vanityDomainStatus (string) --
The approval status of the custom subdomain.
vanityDomain (string) --
The custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.
randomDomain (string) --
The AWS generated subdomain of the private re:Post
customerRoleArn (string) --
The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
createDateTime (datetime) --
The date when the private re:Post was created.
deleteDateTime (datetime) --
The date when the private re:Post was deleted.
tier (string) --
The pricing tier of the private re:Post.
storageLimit (integer) --
The storage limit of the private re:Post.
userAdmins (list) --
The list of users that are administrators of the private re:Post.
(string) --
groupAdmins (list) --
The list of groups that are administrators of the private re:Post.
(string) --
roles (dict) --
A map of accessor identifiers and their roles.
(string) --
(list) --
(string) --
userKMSKey (string) --
The custom AWS KMS key ARN that’s used for the AWS KMS encryption.
userCount (integer) --
The number of users that have onboarded to the private re:Post.
contentSize (integer) --
The content size of the private re:Post.
supportedEmailDomains (dict) --
enabled (string) --
allowedDomains (list) --
(string) --
{'spaces': {'supportedEmailDomains': {'allowedDomains': ['string'],
'enabled': 'ENABLED | DISABLED | '
'NOT_ALLOWED'}}}
Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.
See also: AWS API Documentation
Request Syntax
client.list_spaces(
nextToken='string',
maxResults=123
)
string
The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.
integer
The maximum number of private re:Posts to include in the results.
dict
Response Syntax
{
'spaces': [
{
'spaceId': 'string',
'arn': 'string',
'name': 'string',
'description': 'string',
'status': 'string',
'configurationStatus': 'CONFIGURED'|'UNCONFIGURED',
'vanityDomainStatus': 'PENDING'|'APPROVED'|'UNAPPROVED',
'vanityDomain': 'string',
'randomDomain': 'string',
'tier': 'BASIC'|'STANDARD',
'storageLimit': 123,
'createDateTime': datetime(2015, 1, 1),
'deleteDateTime': datetime(2015, 1, 1),
'userKMSKey': 'string',
'userCount': 123,
'contentSize': 123,
'supportedEmailDomains': {
'enabled': 'ENABLED'|'DISABLED'|'NOT_ALLOWED',
'allowedDomains': [
'string',
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
spaces (list) --
An array of structures that contain some information about the private re:Posts in the account.
(dict) --
A structure that contains some information about a private re:Post in the account.
spaceId (string) --
The unique ID of the private re:Post.
arn (string) --
The ARN of the private re:Post.
name (string) --
The name for the private re:Post.
description (string) --
The description for the private re:Post. This is used only to help you identify this private re:Post.
status (string) --
The creation/deletion status of the private re:Post.
configurationStatus (string) --
The configuration status of the private re:Post.
vanityDomainStatus (string) --
This approval status of the custom subdomain.
vanityDomain (string) --
This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.
randomDomain (string) --
The AWS generated subdomain of the private re:Post.
tier (string) --
The pricing tier of the private re:Post.
storageLimit (integer) --
The storage limit of the private re:Post.
createDateTime (datetime) --
The date when the private re:Post was created.
deleteDateTime (datetime) --
The date when the private re:Post was deleted.
userKMSKey (string) --
The custom AWS KMS key ARN that’s used for the AWS KMS encryption.
userCount (integer) --
The number of onboarded users to the private re:Post.
contentSize (integer) --
The content size of the private re:Post.
supportedEmailDomains (dict) --
enabled (string) --
allowedDomains (list) --
(string) --
nextToken (string) --
The token that you use when you request the next set of private re:Posts.
{'supportedEmailDomains': {'allowedDomains': ['string'],
'enabled': 'ENABLED | DISABLED'}}
Modifies an existing AWS re:Post Private private re:Post.
See also: AWS API Documentation
Request Syntax
client.update_space(
spaceId='string',
description='string',
tier='BASIC'|'STANDARD',
roleArn='string',
supportedEmailDomains={
'enabled': 'ENABLED'|'DISABLED',
'allowedDomains': [
'string',
]
}
)
string
[REQUIRED]
The unique ID of this private re:Post.
string
A description for the private re:Post. This is used only to help you identify this private re:Post.
string
The pricing tier of this private re:Post.
string
The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets.
dict
enabled (string) --
allowedDomains (list) --
(string) --
None