S3OutpostsClient#
Index > S3Outposts > S3OutpostsClient
Auto-generated documentation for S3Outposts type annotations stubs module types-aiobotocore-s3outposts.
S3OutpostsClient#
Type annotations and code completion for session.create_client("s3outposts")
boto3 documentation
S3OutpostsClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_s3outposts.client import S3OutpostsClient
session = get_session()
async with session.create_client("s3outposts") as client:
client: S3OutpostsClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("s3outposts").exceptions
structure.
S3OutpostsClient.exceptions usage example
async with session.create_client("s3outposts") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.OutpostOfflineException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
S3OutpostsClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("s3outposts").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_endpoint#
Creates an endpoint and associates it with the specified Outpost.
Type annotations and code completion for session.create_client("s3outposts").create_endpoint
method.
boto3 documentation
# create_endpoint method definition
await def create_endpoint(
self,
*,
OutpostId: str,
SubnetId: str,
SecurityGroupId: str,
AccessType: EndpointAccessTypeType = ..., # (1)
CustomerOwnedIpv4Pool: str = ...,
) -> CreateEndpointResultTypeDef: # (2)
...
# create_endpoint method usage example with argument unpacking
kwargs: CreateEndpointRequestRequestTypeDef = { # (1)
"OutpostId": ...,
"SubnetId": ...,
"SecurityGroupId": ...,
}
parent.create_endpoint(**kwargs)
delete_endpoint#
Deletes an endpoint.
Type annotations and code completion for session.create_client("s3outposts").delete_endpoint
method.
boto3 documentation
# delete_endpoint method definition
await def delete_endpoint(
self,
*,
EndpointId: str,
OutpostId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_endpoint method usage example with argument unpacking
kwargs: DeleteEndpointRequestRequestTypeDef = { # (1)
"EndpointId": ...,
"OutpostId": ...,
}
parent.delete_endpoint(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("s3outposts").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("s3outposts").list_endpoints
method.
boto3 documentation
# list_endpoints method definition
await def list_endpoints(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEndpointsResultTypeDef: # (1)
...
# list_endpoints method usage example with argument unpacking
kwargs: ListEndpointsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_endpoints(**kwargs)
list_outposts_with_s3#
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
Type annotations and code completion for session.create_client("s3outposts").list_outposts_with_s3
method.
boto3 documentation
# list_outposts_with_s3 method definition
await def list_outposts_with_s3(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListOutpostsWithS3ResultTypeDef: # (1)
...
# list_outposts_with_s3 method usage example with argument unpacking
kwargs: ListOutpostsWithS3RequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_outposts_with_s3(**kwargs)
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 session.create_client("s3outposts").list_shared_endpoints
method.
boto3 documentation
# list_shared_endpoints method definition
await def list_shared_endpoints(
self,
*,
OutpostId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListSharedEndpointsResultTypeDef: # (1)
...
# list_shared_endpoints method usage example with argument unpacking
kwargs: ListSharedEndpointsRequestRequestTypeDef = { # (1)
"OutpostId": ...,
}
parent.list_shared_endpoints(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("s3outposts").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> S3OutpostsClient:
...
__aexit__#
Type annotations and code completion for session.create_client("s3outposts").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("s3outposts").get_paginator
method with overloads.
client.get_paginator("list_endpoints")
-> ListEndpointsPaginatorclient.get_paginator("list_outposts_with_s3")
-> ListOutpostsWithS3Paginatorclient.get_paginator("list_shared_endpoints")
-> ListSharedEndpointsPaginator