Skip to content

Typed dictionaries

Index > S3Outposts > Typed dictionaries

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

CreateEndpointRequestRequestTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import CreateEndpointRequestRequestTypeDef

def get_value() -> CreateEndpointRequestRequestTypeDef:
    return {
        "OutpostId": ...,
        "SubnetId": ...,
        "SecurityGroupId": ...,
    }
Definition
class CreateEndpointRequestRequestTypeDef(TypedDict):
    OutpostId: str,
    SubnetId: str,
    SecurityGroupId: str,
    AccessType: NotRequired[EndpointAccessTypeType],  # (1)
    CustomerOwnedIpv4Pool: NotRequired[str],
  1. See EndpointAccessTypeType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeleteEndpointRequestRequestTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import DeleteEndpointRequestRequestTypeDef

def get_value() -> DeleteEndpointRequestRequestTypeDef:
    return {
        "EndpointId": ...,
        "OutpostId": ...,
    }
Definition
class DeleteEndpointRequestRequestTypeDef(TypedDict):
    EndpointId: str,
    OutpostId: str,

NetworkInterfaceTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import NetworkInterfaceTypeDef

def get_value() -> NetworkInterfaceTypeDef:
    return {
        "NetworkInterfaceId": ...,
    }
Definition
class NetworkInterfaceTypeDef(TypedDict):
    NetworkInterfaceId: NotRequired[str],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListEndpointsRequestRequestTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ListEndpointsRequestRequestTypeDef

def get_value() -> ListEndpointsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
Definition
class ListEndpointsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListSharedEndpointsRequestRequestTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ListSharedEndpointsRequestRequestTypeDef

def get_value() -> ListSharedEndpointsRequestRequestTypeDef:
    return {
        "OutpostId": ...,
    }
Definition
class ListSharedEndpointsRequestRequestTypeDef(TypedDict):
    OutpostId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

CreateEndpointResultTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import CreateEndpointResultTypeDef

def get_value() -> CreateEndpointResultTypeDef:
    return {
        "EndpointArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateEndpointResultTypeDef(TypedDict):
    EndpointArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EndpointTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import EndpointTypeDef

def get_value() -> EndpointTypeDef:
    return {
        "EndpointArn": ...,
    }
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],
  1. See EndpointStatusType
  2. See NetworkInterfaceTypeDef
  3. See EndpointAccessTypeType

ListEndpointsRequestListEndpointsPaginateTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ListEndpointsRequestListEndpointsPaginateTypeDef

def get_value() -> ListEndpointsRequestListEndpointsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListEndpointsRequestListEndpointsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef

def get_value() -> ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef:
    return {
        "OutpostId": ...,
    }
Definition
class ListSharedEndpointsRequestListSharedEndpointsPaginateTypeDef(TypedDict):
    OutpostId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListEndpointsResultTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ListEndpointsResultTypeDef

def get_value() -> ListEndpointsResultTypeDef:
    return {
        "Endpoints": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListEndpointsResultTypeDef(TypedDict):
    Endpoints: List[EndpointTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EndpointTypeDef
  2. See ResponseMetadataTypeDef

ListSharedEndpointsResultTypeDef

Usage Example
from mypy_boto3_s3outposts.type_defs import ListSharedEndpointsResultTypeDef

def get_value() -> ListSharedEndpointsResultTypeDef:
    return {
        "Endpoints": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSharedEndpointsResultTypeDef(TypedDict):
    Endpoints: List[EndpointTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EndpointTypeDef
  2. See ResponseMetadataTypeDef