Skip to content

RePostPrivateClient#

Index > RePostPrivate > RePostPrivateClient

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

RePostPrivateClient#

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

# RePostPrivateClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_repostspace.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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 = ...,
    roleArn: str = ...,
    tags: Mapping[str, str] = ...,
    userKMSKey: str = ...,
) -> CreateSpaceOutputTypeDef:  # (2)
    ...
  1. See TierLevelType
  2. See CreateSpaceOutputTypeDef
# create_space method usage example with argument unpacking

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

parent.create_space(**kwargs)
  1. See CreateSpaceInputRequestTypeDef

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: DeleteSpaceInputRequestTypeDef = {  # (1)
    "spaceId": ...,
}

parent.delete_space(**kwargs)
  1. See DeleteSpaceInputRequestTypeDef

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,
    *,
    adminId: str,
    spaceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# deregister_admin method usage example with argument unpacking

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

parent.deregister_admin(**kwargs)
  1. See DeregisterAdminInputRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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:
    ...

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: GetSpaceInputRequestTypeDef = {  # (1)
    "spaceId": ...,
}

parent.get_space(**kwargs)
  1. See GetSpaceInputRequestTypeDef

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,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSpacesOutputTypeDef:  # (1)
    ...
  1. See ListSpacesOutputTypeDef
# list_spaces method usage example with argument unpacking

kwargs: ListSpacesInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_spaces(**kwargs)
  1. See ListSpacesInputRequestTypeDef

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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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,
    *,
    adminId: str,
    spaceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# register_admin method usage example with argument unpacking

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

parent.register_admin(**kwargs)
  1. See RegisterAdminInputRequestTypeDef

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,
    *,
    accessorIds: Sequence[str],
    body: str,
    spaceId: str,
    title: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# send_invites method usage example with argument unpacking

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

parent.send_invites(**kwargs)
  1. See SendInvitesInputRequestTypeDef

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: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

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 = ...,
    roleArn: str = ...,
    tier: TierLevelType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TierLevelType
  2. See EmptyResponseMetadataTypeDef
# update_space method usage example with argument unpacking

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

parent.update_space(**kwargs)
  1. See