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.