RePostPrivateClient

Index > RePostPrivate > RePostPrivateClient

Auto-generated documentation for RePostPrivate type annotations stubs module types-boto3-repostspace.

RePostPrivateClient

Type annotations and code completion for boto3.client("repostspace"). boto3 documentation

# RePostPrivateClient usage example

from boto3.session import Session
from types_boto3_repostspace.client import RePostPrivateClient

def get_repostspace_client() -> RePostPrivateClient:
    return Session().client("repostspace")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("repostspace").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("repostspace")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_repostspace.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("repostspace").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("repostspace").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

batch_add_channel_role_to_accessors

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

Type annotations and code completion for boto3.client("repostspace").batch_add_channel_role_to_accessors method. boto3 documentation

# batch_add_channel_role_to_accessors method definition

def batch_add_channel_role_to_accessors(
    self,
    *,
    spaceId: str,
    channelId: str,
    accessorIds: Sequence[str],
    channelRole: ChannelRoleType,  # (1)
) -> BatchAddChannelRoleToAccessorsOutputTypeDef:  # (2)
    ...

1. See ChannelRoleType
2. See BatchAddChannelRoleToAccessorsOutputTypeDef

# batch_add_channel_role_to_accessors method usage example with argument unpacking

kwargs: BatchAddChannelRoleToAccessorsInputTypeDef = {  # (1)
    "spaceId": ...,
    "channelId": ...,
    "accessorIds": ...,
    "channelRole": ...,
}

parent.batch_add_channel_role_to_accessors(**kwargs)

1. See BatchAddChannelRoleToAccessorsInputTypeDef

batch_add_role

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

Type annotations and code completion for boto3.client("repostspace").batch_add_role method. boto3 documentation

# batch_add_role method definition

def batch_add_role(
    self,
    *,
    spaceId: str,
    accessorIds: Sequence[str],
    role: RoleType,  # (1)
) -> BatchAddRoleOutputTypeDef:  # (2)
    ...

1. See RoleType
2. See BatchAddRoleOutputTypeDef

# batch_add_role method usage example with argument unpacking

kwargs: BatchAddRoleInputTypeDef = {  # (1)
    "spaceId": ...,
    "accessorIds": ...,
    "role": ...,
}

parent.batch_add_role(**kwargs)

1. See BatchAddRoleInputTypeDef

batch_remove_channel_role_from_accessors

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

Type annotations and code completion for boto3.client("repostspace").batch_remove_channel_role_from_accessors method. boto3 documentation

# batch_remove_channel_role_from_accessors method definition

def batch_remove_channel_role_from_accessors(
    self,
    *,
    spaceId: str,
    channelId: str,
    accessorIds: Sequence[str],
    channelRole: ChannelRoleType,  # (1)
) -> BatchRemoveChannelRoleFromAccessorsOutputTypeDef:  # (2)
    ...

1. See ChannelRoleType
2. See BatchRemoveChannelRoleFromAccessorsOutputTypeDef

# batch_remove_channel_role_from_accessors method usage example with argument unpacking

kwargs: BatchRemoveChannelRoleFromAccessorsInputTypeDef = {  # (1)
    "spaceId": ...,
    "channelId": ...,
    "accessorIds": ...,
    "channelRole": ...,
}

parent.batch_remove_channel_role_from_accessors(**kwargs)

1. See BatchRemoveChannelRoleFromAccessorsInputTypeDef

batch_remove_role

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

Type annotations and code completion for boto3.client("repostspace").batch_remove_role method. boto3 documentation

# batch_remove_role method definition

def batch_remove_role(
    self,
    *,
    spaceId: str,
    accessorIds: Sequence[str],
    role: RoleType,  # (1)
) -> BatchRemoveRoleOutputTypeDef:  # (2)
    ...

1. See RoleType
2. See BatchRemoveRoleOutputTypeDef

# batch_remove_role method usage example with argument unpacking

kwargs: BatchRemoveRoleInputTypeDef = {  # (1)
    "spaceId": ...,
    "accessorIds": ...,
    "role": ...,
}

parent.batch_remove_role(**kwargs)

1. See BatchRemoveRoleInputTypeDef

create_channel

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

Type annotations and code completion for boto3.client("repostspace").create_channel method. boto3 documentation

# create_channel method definition

def create_channel(
    self,
    *,
    spaceId: str,
    channelName: str,
    channelDescription: str = ...,
) -> CreateChannelOutputTypeDef:  # (1)
    ...

1. See CreateChannelOutputTypeDef

# create_channel method usage example with argument unpacking

kwargs: CreateChannelInputTypeDef = {  # (1)
    "spaceId": ...,
    "channelName": ...,
}

parent.create_channel(**kwargs)

1. See CreateChannelInputTypeDef

create_space

Creates an AWS re:Post Private private re:Post.

Type annotations and code completion for boto3.client("repostspace").create_space method. boto3 documentation

# create_space method definition

def create_space(
    self,
    *,
    name: str,
    subdomain: str,
    tier: TierLevelType,  # (1)
    description: str = ...,
    userKMSKey: str = ...,
    tags: Mapping[str, str] = ...,
    roleArn: str = ...,
    supportedEmailDomains: SupportedEmailDomainsParametersTypeDef = ...,  # (2)
) -> CreateSpaceOutputTypeDef:  # (3)
    ...

1. See TierLevelType
2. See SupportedEmailDomainsParametersTypeDef
3. See CreateSpaceOutputTypeDef

# create_space method usage example with argument unpacking

kwargs: CreateSpaceInputTypeDef = {  # (1)
    "name": ...,
    "subdomain": ...,
    "tier": ...,
}

parent.create_space(**kwargs)

1. See CreateSpaceInputTypeDef

delete_space

Deletes an AWS re:Post Private private re:Post.

Type annotations and code completion for boto3.client("repostspace").delete_space method. boto3 documentation

# delete_space method definition

def delete_space(
    self,
    *,
    spaceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_space method usage example with argument unpacking

kwargs: DeleteSpaceInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.delete_space(**kwargs)

1. See DeleteSpaceInputTypeDef

deregister_admin

Removes the user or group from the list of administrators of the private re:Post.

Type annotations and code completion for boto3.client("repostspace").deregister_admin method. boto3 documentation

# deregister_admin method definition

def deregister_admin(
    self,
    *,
    spaceId: str,
    adminId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deregister_admin method usage example with argument unpacking

kwargs: DeregisterAdminInputTypeDef = {  # (1)
    "spaceId": ...,
    "adminId": ...,
}

parent.deregister_admin(**kwargs)

1. See DeregisterAdminInputTypeDef

get_channel

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

Type annotations and code completion for boto3.client("repostspace").get_channel method. boto3 documentation

# get_channel method definition

def get_channel(
    self,
    *,
    spaceId: str,
    channelId: str,
) -> GetChannelOutputTypeDef:  # (1)
    ...

1. See GetChannelOutputTypeDef

# get_channel method usage example with argument unpacking

kwargs: GetChannelInputTypeDef = {  # (1)
    "spaceId": ...,
    "channelId": ...,
}

parent.get_channel(**kwargs)

1. See GetChannelInputTypeDef

get_space

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

Type annotations and code completion for boto3.client("repostspace").get_space method. boto3 documentation

# get_space method definition

def get_space(
    self,
    *,
    spaceId: str,
) -> GetSpaceOutputTypeDef:  # (1)
    ...

1. See GetSpaceOutputTypeDef

# get_space method usage example with argument unpacking

kwargs: GetSpaceInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.get_space(**kwargs)

1. See GetSpaceInputTypeDef

list_channels

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

Type annotations and code completion for boto3.client("repostspace").list_channels method. boto3 documentation

# list_channels method definition

def list_channels(
    self,
    *,
    spaceId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListChannelsOutputTypeDef:  # (1)
    ...

1. See ListChannelsOutputTypeDef

# list_channels method usage example with argument unpacking

kwargs: ListChannelsInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.list_channels(**kwargs)

1. See ListChannelsInputTypeDef

list_spaces

Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.

Type annotations and code completion for boto3.client("repostspace").list_spaces method. boto3 documentation

# list_spaces method definition

def list_spaces(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSpacesOutputTypeDef:  # (1)
    ...

1. See ListSpacesOutputTypeDef

# list_spaces method usage example with argument unpacking

kwargs: ListSpacesInputTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_spaces(**kwargs)

1. See ListSpacesInputTypeDef

list_tags_for_resource

Returns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn.

Type annotations and code completion for boto3.client("repostspace").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

register_admin

Adds a user or group to the list of administrators of the private re:Post.

Type annotations and code completion for boto3.client("repostspace").register_admin method. boto3 documentation

# register_admin method definition

def register_admin(
    self,
    *,
    spaceId: str,
    adminId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# register_admin method usage example with argument unpacking

kwargs: RegisterAdminInputTypeDef = {  # (1)
    "spaceId": ...,
    "adminId": ...,
}

parent.register_admin(**kwargs)

1. See RegisterAdminInputTypeDef

send_invites

Sends an invitation email to selected users and groups.

Type annotations and code completion for boto3.client("repostspace").send_invites method. boto3 documentation

# send_invites method definition

def send_invites(
    self,
    *,
    spaceId: str,
    accessorIds: Sequence[str],
    title: str,
    body: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# send_invites method usage example with argument unpacking

kwargs: SendInvitesInputTypeDef = {  # (1)
    "spaceId": ...,
    "accessorIds": ...,
    "title": ...,
    "body": ...,
}

parent.send_invites(**kwargs)

1. See SendInvitesInputTypeDef

tag_resource

Associates tags with an AWS re:Post Private resource.

Type annotations and code completion for boto3.client("repostspace").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes the association of the tag with the AWS re:Post Private resource.

Type annotations and code completion for boto3.client("repostspace").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_channel

Modifies an existing channel.

Type annotations and code completion for boto3.client("repostspace").update_channel method. boto3 documentation

# update_channel method definition

def update_channel(
    self,
    *,
    spaceId: str,
    channelId: str,
    channelName: str,
    channelDescription: str = ...,
) -> Dict[str, Any]:
    ...

# update_channel method usage example with argument unpacking

kwargs: UpdateChannelInputTypeDef = {  # (1)
    "spaceId": ...,
    "channelId": ...,
    "channelName": ...,
}

parent.update_channel(**kwargs)

1. See UpdateChannelInputTypeDef

update_space

Modifies an existing AWS re:Post Private private re:Post.

Type annotations and code completion for boto3.client("repostspace").update_space method. boto3 documentation

# update_space method definition

def update_space(
    self,
    *,
    spaceId: str,
    description: str = ...,
    tier: TierLevelType = ...,  # (1)
    roleArn: str = ...,
    supportedEmailDomains: SupportedEmailDomainsParametersTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See TierLevelType
2. See SupportedEmailDomainsParametersTypeDef
3. See EmptyResponseMetadataTypeDef

# update_space method usage example with argument unpacking

kwargs: UpdateSpaceInputTypeDef = {  # (1)
    "spaceId": ...,
}

parent.update_space(**kwargs)

1. See UpdateSpaceInputTypeDef

get_paginator

Type annotations and code completion for boto3.client("repostspace").get_paginator method with overloads.

• client.get_paginator("list_channels") -> ListChannelsPaginator
• client.get_paginator("list_spaces") -> ListSpacesPaginator

get_waiter

Type annotations and code completion for boto3.client("repostspace").get_waiter method with overloads.

• client.get_waiter("channel_created") -> ChannelCreatedWaiter
• client.get_waiter("channel_deleted") -> ChannelDeletedWaiter
• client.get_waiter("space_created") -> SpaceCreatedWaiter
• client.get_waiter("space_deleted") -> SpaceDeletedWaiter