Skip to content

S3OutpostsClient#

Index > S3Outposts > S3OutpostsClient

Auto-generated documentation for S3Outposts type annotations stubs module mypy-boto3-s3outposts.

S3OutpostsClient#

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

# S3OutpostsClient usage example

from boto3.session import Session
from mypy_boto3_s3outposts.client import S3OutpostsClient

def get_s3outposts_client() -> S3OutpostsClient:
    return Session().client("s3outposts")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("s3outposts")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.OutpostOfflineException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_s3outposts.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("s3outposts").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("s3outposts").close method. boto3 documentation

# close method definition

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

create_endpoint#

Creates an endpoint and associates it with the specified Outpost.

Type annotations and code completion for boto3.client("s3outposts").create_endpoint method. boto3 documentation

# create_endpoint method definition

def create_endpoint(
    self,
    *,
    OutpostId: str,
    SubnetId: str,
    SecurityGroupId: str,
    AccessType: EndpointAccessTypeType = ...,  # (1)
    CustomerOwnedIpv4Pool: str = ...,
) -> CreateEndpointResultTypeDef:  # (2)
    ...
  1. See EndpointAccessTypeType
  2. See CreateEndpointResultTypeDef 
# create_endpoint method usage example with argument unpacking

kwargs: CreateEndpointRequestRequestTypeDef = {  # (1)
    "OutpostId": ...,
    "SubnetId": ...,
    "SecurityGroupId": ...,
}

parent.create_endpoint(**kwargs)
  1. See CreateEndpointRequestRequestTypeDef

delete_endpoint#

Deletes an endpoint.

Type annotations and code completion for boto3.client("s3outposts").delete_endpoint method. boto3 documentation

# delete_endpoint method definition

def delete_endpoint(
    self,
    *,
    EndpointId: str,
    OutpostId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_endpoint method usage example with argument unpacking

kwargs: DeleteEndpointRequestRequestTypeDef = {  # (1)
    "EndpointId": ...,
    "OutpostId": ...,
}

parent.delete_endpoint(**kwargs)
  1. See DeleteEndpointRequestRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("s3outposts").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:
    ...

list_endpoints#

Lists endpoints associated with the specified Outpost.

Type annotations and code completion for boto3.client("s3outposts").list_endpoints method. boto3 documentation

# list_endpoints method definition

def list_endpoints(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEndpointsResultTypeDef:  # (1)
    ...
  1. See ListEndpointsResultTypeDef 
# list_endpoints method usage example with argument unpacking

kwargs: ListEndpointsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_endpoints(**kwargs)
  1. See ListEndpointsRequestRequestTypeDef

list_outposts_with_s3#

Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.

Type annotations and code completion for boto3.client("s3outposts").list_outposts_with_s3 method. boto3 documentation

# list_outposts_with_s3 method definition

def list_outposts_with_s3(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListOutpostsWithS3ResultTypeDef:  # (1)
    ...
  1. See ListOutpostsWithS3ResultTypeDef 
# list_outposts_with_s3 method usage example with argument unpacking

kwargs: ListOutpostsWithS3RequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_outposts_with_s3(**kwargs)
  1. See ListOutpostsWithS3RequestRequestTypeDef

list_shared_endpoints#

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

Type annotations and code completion for boto3.client("s3outposts").list_shared_endpoints method. boto3 documentation

# list_shared_endpoints method definition

def list_shared_endpoints(
    self,
    *,
    OutpostId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListSharedEndpointsResultTypeDef:  # (1)
    ...
  1. See ListSharedEndpointsResultTypeDef 
# list_shared_endpoints method usage example with argument unpacking

kwargs: ListSharedEndpointsRequestRequestTypeDef = {  # (1)
    "OutpostId": ...,
}

parent.list_shared_endpoints(**kwargs)
  1. See ListSharedEndpointsRequestRequestTypeDef

get_paginator#

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