rePostPrivate ************* Client ====== class rePostPrivate.Client A low-level client representing AWS re:Post Private AWS re:Post Private is a private version of AWS re:Post for enterprises with Enterprise Support or Enterprise On-Ramp Support plans. It provides access to knowledge and experts to accelerate cloud adoption and increase developer productivity. With your organization-specific private re:Post, you can build an organization-specific developer community that drives efficiencies at scale and provides access to valuable knowledge resources. Additionally, re:Post Private centralizes trusted AWS technical content and offers private discussion forums to improve how your teams collaborate internally and with AWS to remove technical obstacles, accelerate innovation, and scale more efficiently in the cloud. import boto3 client = boto3.client('repostspace') These are the available methods: * batch_add_channel_role_to_accessors * batch_add_role * batch_remove_channel_role_from_accessors * batch_remove_role * can_paginate * close * create_channel * create_space * delete_space * deregister_admin * get_channel * get_paginator * get_space * get_waiter * list_channels * list_spaces * list_tags_for_resource * register_admin * send_invites * tag_resource * untag_resource * update_channel * update_space Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListChannels * ListSpaces Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * ChannelCreated * ChannelDeleted * SpaceCreated * SpaceDeleted rePostPrivate / Waiter / SpaceDeleted SpaceDeleted ************ class rePostPrivate.Waiter.SpaceDeleted waiter = client.get_waiter('space_deleted') wait(**kwargs) Polls "rePostPrivate.Client.get_space()" every 300 seconds until a successful state is reached. An error is raised after 24 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( spaceId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The ID of the private re:Post. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 300 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 24 Returns: None rePostPrivate / Waiter / ChannelDeleted ChannelDeleted ************** class rePostPrivate.Waiter.ChannelDeleted waiter = client.get_waiter('channel_deleted') wait(**kwargs) Polls "rePostPrivate.Client.get_channel()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( spaceId='string', channelId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post channel. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None rePostPrivate / Waiter / SpaceCreated SpaceCreated ************ class rePostPrivate.Waiter.SpaceCreated waiter = client.get_waiter('space_created') wait(**kwargs) Polls "rePostPrivate.Client.get_space()" every 300 seconds until a successful state is reached. An error is raised after 24 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( spaceId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The ID of the private re:Post. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 300 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 24 Returns: None rePostPrivate / Waiter / ChannelCreated ChannelCreated ************** class rePostPrivate.Waiter.ChannelCreated waiter = client.get_waiter('channel_created') wait(**kwargs) Polls "rePostPrivate.Client.get_channel()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( spaceId='string', channelId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post channel. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None rePostPrivate / Paginator / ListSpaces ListSpaces ********** class rePostPrivate.Paginator.ListSpaces paginator = client.get_paginator('list_spaces') paginate(**kwargs) Creates an iterator that will paginate through responses from "rePostPrivate.Client.list_spaces()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* A token to resume pagination. rePostPrivate / Paginator / ListChannels ListChannels ************ class rePostPrivate.Paginator.ListChannels paginator = client.get_paginator('list_channels') paginate(**kwargs) Creates an iterator that will paginate through responses from "rePostPrivate.Client.list_channels()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( spaceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* A token to resume pagination. rePostPrivate / Client / send_invites send_invites ************ rePostPrivate.Client.send_invites(**kwargs) Sends an invitation email to selected users and groups. See also: AWS API Documentation **Request Syntax** response = client.send_invites( spaceId='string', accessorIds=[ 'string', ], title='string', body='string' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The ID of the private re:Post. * **accessorIds** (*list*) -- **[REQUIRED]** The array of identifiers for the users and groups. * *(string) --* * **title** (*string*) -- **[REQUIRED]** The title of the invite. * **body** (*string*) -- **[REQUIRED]** The body of the invite. Returns: None **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / get_paginator get_paginator ************* rePostPrivate.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. rePostPrivate / Client / batch_remove_role batch_remove_role ***************** rePostPrivate.Client.batch_remove_role(**kwargs) Remove a role from multiple users or groups in a private re:Post. See also: AWS API Documentation **Request Syntax** response = client.batch_remove_role( spaceId='string', accessorIds=[ 'string', ], role='EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **accessorIds** (*list*) -- **[REQUIRED]** The user or group accessor identifiers to remove the role from. * *(string) --* * **role** (*string*) -- **[REQUIRED]** The role to remove from the users or groups. Return type: dict Returns: **Response Syntax** { 'removedAccessorIds': [ 'string', ], 'errors': [ { 'accessorId': 'string', 'error': 123, 'message': 'string' }, ] } **Response Structure** * *(dict) --* * **removedAccessorIds** *(list) --* An array of successfully updated accessor 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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / batch_add_role batch_add_role ************** rePostPrivate.Client.batch_add_role(**kwargs) Add a role to multiple users or groups in a private re:Post. See also: AWS API Documentation **Request Syntax** response = client.batch_add_role( spaceId='string', accessorIds=[ 'string', ], role='EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **accessorIds** (*list*) -- **[REQUIRED]** The user or group accessor identifiers to add the role to. * *(string) --* * **role** (*string*) -- **[REQUIRED]** The role to add to the users or groups. Return type: dict Returns: **Response Syntax** { 'addedAccessorIds': [ 'string', ], 'errors': [ { 'accessorId': 'string', 'error': 123, 'message': 'string' }, ] } **Response Structure** * *(dict) --* * **addedAccessorIds** *(list) --* An array of successfully updated accessor 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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / list_channels list_channels ************* rePostPrivate.Client.list_channels(**kwargs) Returns the list of channel within a private re:Post with some information about each channel. See also: AWS API Documentation **Request Syntax** response = client.list_channels( spaceId='string', nextToken='string', maxResults=123 ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **nextToken** (*string*) -- The token for the next set of channel to return. You receive this token from a previous ListChannels operation. * **maxResults** (*integer*) -- The maximum number of channels to include in the results. Return type: dict Returns: **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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / can_paginate can_paginate ************ rePostPrivate.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. rePostPrivate / Client / get_channel get_channel *********** rePostPrivate.Client.get_channel(**kwargs) Displays information about a channel in a private re:Post. See also: AWS API Documentation **Request Syntax** response = client.get_channel( spaceId='string', channelId='string' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post channel. Return type: dict Returns: **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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / delete_space delete_space ************ rePostPrivate.Client.delete_space(**kwargs) Deletes an AWS re:Post Private private re:Post. See also: AWS API Documentation **Request Syntax** response = client.delete_space( spaceId='string' ) Parameters: **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. Returns: None **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / deregister_admin deregister_admin **************** rePostPrivate.Client.deregister_admin(**kwargs) Removes the user or group from the list of administrators of the private re:Post. See also: AWS API Documentation **Request Syntax** response = client.deregister_admin( spaceId='string', adminId='string' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The ID of the private re:Post to remove the admin from. * **adminId** (*string*) -- **[REQUIRED]** The ID of the admin to remove. Returns: None **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / list_tags_for_resource list_tags_for_resource ********************** rePostPrivate.Client.list_tags_for_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource that the tags are associated with. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The list of tags that are associated with the resource. * *(string) --* * *(string) --* **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / untag_resource untag_resource ************** rePostPrivate.Client.untag_resource(**kwargs) Removes the association of the tag with the AWS re:Post Private resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **tagKeys** (*list*) -- **[REQUIRED]** The key values of the tag. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / list_spaces list_spaces *********** rePostPrivate.Client.list_spaces(**kwargs) 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** response = client.list_spaces( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation. * **maxResults** (*integer*) -- The maximum number of private re:Posts to include in the results. Return type: dict Returns: **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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / get_waiter get_waiter ********** rePostPrivate.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" rePostPrivate / Client / create_channel create_channel ************** rePostPrivate.Client.create_channel(**kwargs) Creates a channel in an AWS re:Post Private private re:Post. See also: AWS API Documentation **Request Syntax** response = client.create_channel( spaceId='string', channelName='string', channelDescription='string' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** { 'channelId': 'string' } **Response Structure** * *(dict) --* * **channelId** *(string) --* The unique ID of the private re:Post channel. **Exceptions** * "rePostPrivate.Client.exceptions.ServiceQuotaExceededException" * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ConflictException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / get_space get_space ********* rePostPrivate.Client.get_space(**kwargs) Displays information about the AWS re:Post Private private re:Post. See also: AWS API Documentation **Request Syntax** response = client.get_space( spaceId='string' ) Parameters: **spaceId** (*string*) -- **[REQUIRED]** The ID of the private re:Post. Return type: dict Returns: **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) --* **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / create_space create_space ************ rePostPrivate.Client.create_space(**kwargs) Creates an AWS re:Post Private private re:Post. See also: AWS API Documentation **Request Syntax** response = 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', ] } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name for the private re:Post. This must be unique in your account. * **subdomain** (*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. * **tier** (*string*) -- **[REQUIRED]** The pricing tier for the private re:Post. * **description** (*string*) -- A description for the private re:Post. This is used only to help you identify this private re:Post. * **userKMSKey** (*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. * **tags** (*dict*) -- The list of tags associated with the private re:Post. * *(string) --* * *(string) --* * **roleArn** (*string*) -- The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets. * **supportedEmailDomains** (*dict*) -- * **enabled** *(string) --* * **allowedDomains** *(list) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'spaceId': 'string' } **Response Structure** * *(dict) --* * **spaceId** *(string) --* The unique ID of the private re:Post. **Exceptions** * "rePostPrivate.Client.exceptions.ServiceQuotaExceededException" * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ConflictException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / register_admin register_admin ************** rePostPrivate.Client.register_admin(**kwargs) Adds a user or group to the list of administrators of the private re:Post. See also: AWS API Documentation **Request Syntax** response = client.register_admin( spaceId='string', adminId='string' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The ID of the private re:Post. * **adminId** (*string*) -- **[REQUIRED]** The ID of the administrator. Returns: None **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / batch_add_channel_role_to_accessors batch_add_channel_role_to_accessors *********************************** rePostPrivate.Client.batch_add_channel_role_to_accessors(**kwargs) Add role to multiple users or groups in a private re:Post channel. See also: AWS API Documentation **Request Syntax** response = client.batch_add_channel_role_to_accessors( spaceId='string', channelId='string', accessorIds=[ 'string', ], channelRole='ASKER'|'EXPERT'|'MODERATOR'|'SUPPORTREQUESTOR' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post channel. * **accessorIds** (*list*) -- **[REQUIRED]** The user or group identifiers to add the role to. * *(string) --* * **channelRole** (*string*) -- **[REQUIRED]** The channel role to add to the users or groups. Return type: dict Returns: **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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / close close ***** rePostPrivate.Client.close() Closes underlying endpoint connections. rePostPrivate / Client / update_space update_space ************ rePostPrivate.Client.update_space(**kwargs) Modifies an existing AWS re:Post Private private re:Post. See also: AWS API Documentation **Request Syntax** response = client.update_space( spaceId='string', description='string', tier='BASIC'|'STANDARD', roleArn='string', supportedEmailDomains={ 'enabled': 'ENABLED'|'DISABLED', 'allowedDomains': [ 'string', ] } ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of this private re:Post. * **description** (*string*) -- A description for the private re:Post. This is used only to help you identify this private re:Post. * **tier** (*string*) -- The pricing tier of this private re:Post. * **roleArn** (*string*) -- The IAM role that grants permissions to the private re:Post to convert unanswered questions into AWS support tickets. * **supportedEmailDomains** (*dict*) -- * **enabled** *(string) --* * **allowedDomains** *(list) --* * *(string) --* Returns: None **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ConflictException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / tag_resource tag_resource ************ rePostPrivate.Client.tag_resource(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource that the tag is associated with. * **tags** (*dict*) -- **[REQUIRED]** 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. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / update_channel update_channel ************** rePostPrivate.Client.update_channel(**kwargs) Modifies an existing channel. See also: AWS API Documentation **Request Syntax** response = client.update_channel( spaceId='string', channelId='string', channelName='string', channelDescription='string' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post channel. * **channelName** (*string*) -- **[REQUIRED]** 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. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ConflictException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException" rePostPrivate / Client / batch_remove_channel_role_from_accessors batch_remove_channel_role_from_accessors **************************************** rePostPrivate.Client.batch_remove_channel_role_from_accessors(**kwargs) Remove a role from multiple users or groups in a private re:Post channel. See also: AWS API Documentation **Request Syntax** response = client.batch_remove_channel_role_from_accessors( spaceId='string', channelId='string', accessorIds=[ 'string', ], channelRole='ASKER'|'EXPERT'|'MODERATOR'|'SUPPORTREQUESTOR' ) Parameters: * **spaceId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post. * **channelId** (*string*) -- **[REQUIRED]** The unique ID of the private re:Post channel. * **accessorIds** (*list*) -- **[REQUIRED]** The users or groups identifiers to remove the role from. * *(string) --* * **channelRole** (*string*) -- **[REQUIRED]** The channel role to remove from the users or groups. Return type: dict Returns: **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. **Exceptions** * "rePostPrivate.Client.exceptions.ValidationException" * "rePostPrivate.Client.exceptions.AccessDeniedException" * "rePostPrivate.Client.exceptions.ResourceNotFoundException" * "rePostPrivate.Client.exceptions.ThrottlingException" * "rePostPrivate.Client.exceptions.InternalServerException"