Typed dictionaries#
Index > S3Outposts > Typed dictionaries
Auto-generated documentation for S3Outposts type annotations stubs module mypy-boto3-s3outposts.
CreateEndpointRequestRequestTypeDef#
# CreateEndpointRequestRequestTypeDef usage example
from mypy_boto3_s3outposts.type_defs import CreateEndpointRequestRequestTypeDef
def get_value() -> CreateEndpointRequestRequestTypeDef:
return {
"OutpostId": ...,
"SubnetId": ...,
"SecurityGroupId": ...,
}
# CreateEndpointRequestRequestTypeDef definition
class CreateEndpointRequestRequestTypeDef(TypedDict):
OutpostId: str,
SubnetId: str,
SecurityGroupId: str,
AccessType: NotRequired[EndpointAccessTypeType], # (1)
CustomerOwnedIpv4Pool: NotRequired[str],
CreateEndpointResultTypeDef#
# CreateEndpointResultTypeDef usage example
from mypy_boto3_s3outposts.type_defs import CreateEndpointResultTypeDef
def get_value() -> CreateEndpointResultTypeDef:
return {
"EndpointArn": ...,
"ResponseMetadata": ...,
}
# CreateEndpointResultTypeDef definition
class CreateEndpointResultTypeDef(TypedDict):
EndpointArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteEndpointRequestRequestTypeDef#
# DeleteEndpointRequestRequestTypeDef usage example
from mypy_boto3_s3outposts.type_defs import DeleteEndpointRequestRequestTypeDef
def get_value() -> DeleteEndpointRequestRequestTypeDef:
return {
"EndpointId": ...,
"OutpostId": ...,
}
# DeleteEndpointRequestRequestTypeDef definition
class DeleteEndpointRequestRequestTypeDef(TypedDict):
EndpointId: str,
OutpostId: str,
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_s3outposts.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
FailedReasonTypeDef#
# FailedReasonTypeDef usage example
from mypy_boto3_s3outposts.type_defs import FailedReasonTypeDef
def get_value() -> FailedReasonTypeDef:
return {
"ErrorCode": ...,
}
# FailedReasonTypeDef definition
class FailedReasonTypeDef(TypedDict):
ErrorCode: NotRequired[str],
Message: NotRequired[str],
NetworkInterfaceTypeDef#
# NetworkInterfaceTypeDef usage example
from mypy_boto3_s3outposts.type_defs import NetworkInterfaceTypeDef
def get_value() -> NetworkInterfaceTypeDef:
return {
"NetworkInterfaceId": ...,
}
# NetworkInterfaceTypeDef definition
class NetworkInterfaceTypeDef(TypedDict):
NetworkInterfaceId: NotRequired[str],
ListEndpointsRequestListEndpointsPaginateTypeDef#
# ListEndpointsRequestListEndpointsPaginateTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListEndpointsRequestListEndpointsPaginateTypeDef
def get_value() -> ListEndpointsRequestListEndpointsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListEndpointsRequestListEndpointsPaginateTypeDef definition
class ListEndpointsRequestListEndpointsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListEndpointsRequestRequestTypeDef#
# ListEndpointsRequestRequestTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListEndpointsRequestRequestTypeDef
def get_value() -> ListEndpointsRequestRequestTypeDef:
return {
"NextToken": ...,
}
# ListEndpointsRequestRequestTypeDef definition
class ListEndpointsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListOutpostsWithS3RequestListOutpostsWithS3PaginateTypeDef#
# ListOutpostsWithS3RequestListOutpostsWithS3PaginateTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListOutpostsWithS3RequestListOutpostsWithS3PaginateTypeDef
def get_value() -> ListOutpostsWithS3RequestListOutpostsWithS3PaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListOutpostsWithS3RequestListOutpostsWithS3PaginateTypeDef definition
class ListOutpostsWithS3RequestListOutpostsWithS3PaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListOutpostsWithS3RequestRequestTypeDef#
# ListOutpostsWithS3RequestRequestTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListOutpostsWithS3RequestRequestTypeDef
def get_value() -> ListOutpostsWithS3RequestRequestTypeDef:
return {
"NextToken": ...,
}
# ListOutpostsWithS3RequestRequestTypeDef definition
class ListOutpostsWithS3RequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
OutpostTypeDef#
# OutpostTypeDef usage example
from mypy_boto3_s3outposts.type_defs import OutpostTypeDef
def get_value() -> OutpostTypeDef:
return {
"OutpostArn": ...,
}
# OutpostTypeDef definition
class OutpostTypeDef(TypedDict):
OutpostArn: NotRequired[str],
OutpostId: NotRequired[str],
OwnerId: NotRequired[str],
CapacityInBytes: NotRequired[int],
ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef#
# ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef
def get_value() -> ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef:
return {
"OutpostId": ...,
}
# ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef definition
class ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef(TypedDict):
OutpostId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSharedEndpointsRequestRequestTypeDef#
# ListSharedEndpointsRequestRequestTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListSharedEndpointsRequestRequestTypeDef
def get_value() -> ListSharedEndpointsRequestRequestTypeDef:
return {
"OutpostId": ...,
}
# ListSharedEndpointsRequestRequestTypeDef definition
class ListSharedEndpointsRequestRequestTypeDef(TypedDict):
OutpostId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_s3outposts.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
EndpointTypeDef#
# EndpointTypeDef usage example
from mypy_boto3_s3outposts.type_defs import EndpointTypeDef
def get_value() -> EndpointTypeDef:
return {
"EndpointArn": ...,
}
# EndpointTypeDef definition
class EndpointTypeDef(TypedDict):
EndpointArn: NotRequired[str],
OutpostsId: NotRequired[str],
CidrBlock: NotRequired[str],
Status: NotRequired[EndpointStatusType], # (1)
CreationTime: NotRequired[datetime],
NetworkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]], # (2)
VpcId: NotRequired[str],
SubnetId: NotRequired[str],
SecurityGroupId: NotRequired[str],
AccessType: NotRequired[EndpointAccessTypeType], # (3)
CustomerOwnedIpv4Pool: NotRequired[str],
FailedReason: NotRequired[FailedReasonTypeDef], # (4)
- See EndpointStatusType
- See NetworkInterfaceTypeDef
- See EndpointAccessTypeType
- See FailedReasonTypeDef
ListOutpostsWithS3ResultTypeDef#
# ListOutpostsWithS3ResultTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListOutpostsWithS3ResultTypeDef
def get_value() -> ListOutpostsWithS3ResultTypeDef:
return {
"Outposts": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListOutpostsWithS3ResultTypeDef definition
class ListOutpostsWithS3ResultTypeDef(TypedDict):
Outposts: List[OutpostTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEndpointsResultTypeDef#
# ListEndpointsResultTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListEndpointsResultTypeDef
def get_value() -> ListEndpointsResultTypeDef:
return {
"Endpoints": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListEndpointsResultTypeDef definition
class ListEndpointsResultTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSharedEndpointsResultTypeDef#
# ListSharedEndpointsResultTypeDef usage example
from mypy_boto3_s3outposts.type_defs import ListSharedEndpointsResultTypeDef
def get_value() -> ListSharedEndpointsResultTypeDef:
return {
"Endpoints": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListSharedEndpointsResultTypeDef definition
class ListSharedEndpointsResultTypeDef(TypedDict):
Endpoints: List[EndpointTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)