Skip to content

Type definitions#

Index > Outposts > Type definitions

Auto-generated documentation for Outposts type annotations stubs module mypy-boto3-outposts.

AddressTypeDef#

# AddressTypeDef definition

class AddressTypeDef(TypedDict):
    AddressLine1: str,
    City: str,
    StateOrRegion: str,
    PostalCode: str,
    CountryCode: str,
    ContactName: NotRequired[str],
    ContactPhoneNumber: NotRequired[str],
    AddressLine2: NotRequired[str],
    AddressLine3: NotRequired[str],
    DistrictOrCounty: NotRequired[str],
    Municipality: NotRequired[str],

AssetLocationTypeDef#

# AssetLocationTypeDef definition

class AssetLocationTypeDef(TypedDict):
    RackElevation: NotRequired[float],

ComputeAttributesTypeDef#

# ComputeAttributesTypeDef definition

class ComputeAttributesTypeDef(TypedDict):
    HostId: NotRequired[str],
    State: NotRequired[ComputeAssetStateType],  # (1)
    InstanceFamilies: NotRequired[List[str]],
  1. See ComputeAssetStateType

CancelCapacityTaskInputRequestTypeDef#

# CancelCapacityTaskInputRequestTypeDef definition

class CancelCapacityTaskInputRequestTypeDef(TypedDict):
    CapacityTaskId: str,
    OutpostIdentifier: str,

CancelOrderInputRequestTypeDef#

# CancelOrderInputRequestTypeDef definition

class CancelOrderInputRequestTypeDef(TypedDict):
    OrderId: str,

CapacityTaskFailureTypeDef#

# CapacityTaskFailureTypeDef definition

class CapacityTaskFailureTypeDef(TypedDict):
    Reason: str,
    Type: NotRequired[CapacityTaskFailureTypeType],  # (1)
  1. See CapacityTaskFailureTypeType

CapacityTaskSummaryTypeDef#

# CapacityTaskSummaryTypeDef definition

class CapacityTaskSummaryTypeDef(TypedDict):
    CapacityTaskId: NotRequired[str],
    OutpostId: NotRequired[str],
    OrderId: NotRequired[str],
    CapacityTaskStatus: NotRequired[CapacityTaskStatusType],  # (1)
    CreationDate: NotRequired[datetime],
    CompletionDate: NotRequired[datetime],
    LastModifiedDate: NotRequired[datetime],
  1. See CapacityTaskStatusType

EC2CapacityTypeDef#

# EC2CapacityTypeDef definition

class EC2CapacityTypeDef(TypedDict):
    Family: NotRequired[str],
    MaxSize: NotRequired[str],
    Quantity: NotRequired[str],

ConnectionDetailsTypeDef#

# ConnectionDetailsTypeDef definition

class ConnectionDetailsTypeDef(TypedDict):
    ClientPublicKey: NotRequired[str],
    ServerPublicKey: NotRequired[str],
    ServerEndpoint: NotRequired[str],
    ClientTunnelAddress: NotRequired[str],
    ServerTunnelAddress: NotRequired[str],
    AllowedIps: NotRequired[List[str]],

LineItemRequestTypeDef#

# LineItemRequestTypeDef definition

class LineItemRequestTypeDef(TypedDict):
    CatalogItemId: NotRequired[str],
    Quantity: NotRequired[int],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateOutpostInputRequestTypeDef#

# CreateOutpostInputRequestTypeDef definition

class CreateOutpostInputRequestTypeDef(TypedDict):
    Name: str,
    SiteId: str,
    Description: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    AvailabilityZoneId: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    SupportedHardwareType: NotRequired[SupportedHardwareTypeType],  # (1)
  1. See SupportedHardwareTypeType

OutpostTypeDef#

# OutpostTypeDef definition

class OutpostTypeDef(TypedDict):
    OutpostId: NotRequired[str],
    OwnerId: NotRequired[str],
    OutpostArn: NotRequired[str],
    SiteId: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    LifeCycleStatus: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    AvailabilityZoneId: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    SiteArn: NotRequired[str],
    SupportedHardwareType: NotRequired[SupportedHardwareTypeType],  # (1)
  1. See SupportedHardwareTypeType

RackPhysicalPropertiesTypeDef#

# RackPhysicalPropertiesTypeDef definition

class RackPhysicalPropertiesTypeDef(TypedDict):
    PowerDrawKva: NotRequired[PowerDrawKvaType],  # (1)
    PowerPhase: NotRequired[PowerPhaseType],  # (2)
    PowerConnector: NotRequired[PowerConnectorType],  # (3)
    PowerFeedDrop: NotRequired[PowerFeedDropType],  # (4)
    UplinkGbps: NotRequired[UplinkGbpsType],  # (5)
    UplinkCount: NotRequired[UplinkCountType],  # (6)
    FiberOpticCableType: NotRequired[FiberOpticCableTypeType],  # (7)
    OpticalStandard: NotRequired[OpticalStandardType],  # (8)
    MaximumSupportedWeightLbs: NotRequired[MaximumSupportedWeightLbsType],  # (9)
  1. See PowerDrawKvaType
  2. See PowerPhaseType
  3. See PowerConnectorType
  4. See PowerFeedDropType
  5. See UplinkGbpsType
  6. See UplinkCountType
  7. See FiberOpticCableTypeType
  8. See OpticalStandardType
  9. See MaximumSupportedWeightLbsType

DeleteOutpostInputRequestTypeDef#

# DeleteOutpostInputRequestTypeDef definition

class DeleteOutpostInputRequestTypeDef(TypedDict):
    OutpostId: str,

DeleteSiteInputRequestTypeDef#

# DeleteSiteInputRequestTypeDef definition

class DeleteSiteInputRequestTypeDef(TypedDict):
    SiteId: str,

GetCapacityTaskInputRequestTypeDef#

# GetCapacityTaskInputRequestTypeDef definition

class GetCapacityTaskInputRequestTypeDef(TypedDict):
    CapacityTaskId: str,
    OutpostIdentifier: str,

InstanceTypeCapacityTypeDef#

# InstanceTypeCapacityTypeDef definition

class InstanceTypeCapacityTypeDef(TypedDict):
    InstanceType: str,
    Count: int,

GetCatalogItemInputRequestTypeDef#

# GetCatalogItemInputRequestTypeDef definition

class GetCatalogItemInputRequestTypeDef(TypedDict):
    CatalogItemId: str,

GetConnectionRequestRequestTypeDef#

# GetConnectionRequestRequestTypeDef definition

class GetConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

GetOrderInputRequestTypeDef#

# GetOrderInputRequestTypeDef definition

class GetOrderInputRequestTypeDef(TypedDict):
    OrderId: str,

GetOutpostInputRequestTypeDef#

# GetOutpostInputRequestTypeDef definition

class GetOutpostInputRequestTypeDef(TypedDict):
    OutpostId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetOutpostInstanceTypesInputRequestTypeDef#

# GetOutpostInstanceTypesInputRequestTypeDef definition

class GetOutpostInstanceTypesInputRequestTypeDef(TypedDict):
    OutpostId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

InstanceTypeItemTypeDef#

# InstanceTypeItemTypeDef definition

class InstanceTypeItemTypeDef(TypedDict):
    InstanceType: NotRequired[str],

GetOutpostSupportedInstanceTypesInputRequestTypeDef#

# GetOutpostSupportedInstanceTypesInputRequestTypeDef definition

class GetOutpostSupportedInstanceTypesInputRequestTypeDef(TypedDict):
    OutpostIdentifier: str,
    OrderId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetSiteAddressInputRequestTypeDef#

# GetSiteAddressInputRequestTypeDef definition

class GetSiteAddressInputRequestTypeDef(TypedDict):
    SiteId: str,
    AddressType: AddressTypeType,  # (1)
  1. See AddressTypeType

GetSiteInputRequestTypeDef#

# GetSiteInputRequestTypeDef definition

class GetSiteInputRequestTypeDef(TypedDict):
    SiteId: str,

LineItemAssetInformationTypeDef#

# LineItemAssetInformationTypeDef definition

class LineItemAssetInformationTypeDef(TypedDict):
    AssetId: NotRequired[str],
    MacAddressList: NotRequired[List[str]],

ShipmentInformationTypeDef#

# ShipmentInformationTypeDef definition

class ShipmentInformationTypeDef(TypedDict):
    ShipmentTrackingNumber: NotRequired[str],
    ShipmentCarrier: NotRequired[ShipmentCarrierType],  # (1)
  1. See ShipmentCarrierType

ListAssetsInputRequestTypeDef#

# ListAssetsInputRequestTypeDef definition

class ListAssetsInputRequestTypeDef(TypedDict):
    OutpostIdentifier: str,
    HostIdFilter: NotRequired[Sequence[str]],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    StatusFilter: NotRequired[Sequence[AssetStateType]],  # (1)
  1. See AssetStateType

ListCapacityTasksInputRequestTypeDef#

# ListCapacityTasksInputRequestTypeDef definition

class ListCapacityTasksInputRequestTypeDef(TypedDict):
    OutpostIdentifierFilter: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    CapacityTaskStatusFilter: NotRequired[Sequence[CapacityTaskStatusType]],  # (1)
  1. See CapacityTaskStatusType

ListCatalogItemsInputRequestTypeDef#

# ListCatalogItemsInputRequestTypeDef definition

class ListCatalogItemsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ItemClassFilter: NotRequired[Sequence[CatalogItemClassType]],  # (1)
    SupportedStorageFilter: NotRequired[Sequence[SupportedStorageEnumType]],  # (2)
    EC2FamilyFilter: NotRequired[Sequence[str]],
  1. See CatalogItemClassType
  2. See SupportedStorageEnumType

ListOrdersInputRequestTypeDef#

# ListOrdersInputRequestTypeDef definition

class ListOrdersInputRequestTypeDef(TypedDict):
    OutpostIdentifierFilter: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

OrderSummaryTypeDef#

# OrderSummaryTypeDef definition

class OrderSummaryTypeDef(TypedDict):
    OutpostId: NotRequired[str],
    OrderId: NotRequired[str],
    OrderType: NotRequired[OrderTypeType],  # (1)
    Status: NotRequired[OrderStatusType],  # (2)
    LineItemCountsByStatus: NotRequired[Dict[LineItemStatusType, int]],  # (3)
    OrderSubmissionDate: NotRequired[datetime],
    OrderFulfilledDate: NotRequired[datetime],
  1. See OrderTypeType
  2. See OrderStatusType
  3. See LineItemStatusType

ListOutpostsInputRequestTypeDef#

# ListOutpostsInputRequestTypeDef definition

class ListOutpostsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    LifeCycleStatusFilter: NotRequired[Sequence[str]],
    AvailabilityZoneFilter: NotRequired[Sequence[str]],
    AvailabilityZoneIdFilter: NotRequired[Sequence[str]],

ListSitesInputRequestTypeDef#

# ListSitesInputRequestTypeDef definition

class ListSitesInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    OperatingAddressCountryCodeFilter: NotRequired[Sequence[str]],
    OperatingAddressStateOrRegionFilter: NotRequired[Sequence[str]],
    OperatingAddressCityFilter: NotRequired[Sequence[str]],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

StartConnectionRequestRequestTypeDef#

# StartConnectionRequestRequestTypeDef definition

class StartConnectionRequestRequestTypeDef(TypedDict):
    AssetId: str,
    ClientPublicKey: str,
    NetworkInterfaceDeviceIndex: int,
    DeviceSerialNumber: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateOutpostInputRequestTypeDef#

# UpdateOutpostInputRequestTypeDef definition

class UpdateOutpostInputRequestTypeDef(TypedDict):
    OutpostId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    SupportedHardwareType: NotRequired[SupportedHardwareTypeType],  # (1)
  1. See SupportedHardwareTypeType

UpdateSiteInputRequestTypeDef#

# UpdateSiteInputRequestTypeDef definition

class UpdateSiteInputRequestTypeDef(TypedDict):
    SiteId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    Notes: NotRequired[str],

UpdateSiteRackPhysicalPropertiesInputRequestTypeDef#

# UpdateSiteRackPhysicalPropertiesInputRequestTypeDef definition

class UpdateSiteRackPhysicalPropertiesInputRequestTypeDef(TypedDict):
    SiteId: str,
    PowerDrawKva: NotRequired[PowerDrawKvaType],  # (1)
    PowerPhase: NotRequired[PowerPhaseType],  # (2)
    PowerConnector: NotRequired[PowerConnectorType],  # (3)
    PowerFeedDrop: NotRequired[PowerFeedDropType],  # (4)
    UplinkGbps: NotRequired[UplinkGbpsType],  # (5)
    UplinkCount: NotRequired[UplinkCountType],  # (6)
    FiberOpticCableType: NotRequired[FiberOpticCableTypeType],  # (7)
    OpticalStandard: NotRequired[OpticalStandardType],  # (8)
    MaximumSupportedWeightLbs: NotRequired[MaximumSupportedWeightLbsType],  # (9)
  1. See PowerDrawKvaType
  2. See PowerPhaseType
  3. See PowerConnectorType
  4. See PowerFeedDropType
  5. See UplinkGbpsType
  6. See UplinkCountType
  7. See FiberOpticCableTypeType
  8. See OpticalStandardType
  9. See MaximumSupportedWeightLbsType

UpdateSiteAddressInputRequestTypeDef#

# UpdateSiteAddressInputRequestTypeDef definition

class UpdateSiteAddressInputRequestTypeDef(TypedDict):
    SiteId: str,
    AddressType: AddressTypeType,  # (1)
    Address: AddressTypeDef,  # (2)
  1. See AddressTypeType
  2. See AddressTypeDef

AssetInfoTypeDef#

# AssetInfoTypeDef definition

class AssetInfoTypeDef(TypedDict):
    AssetId: NotRequired[str],
    RackId: NotRequired[str],
    AssetType: NotRequired[AssetTypeType],  # (1)
    ComputeAttributes: NotRequired[ComputeAttributesTypeDef],  # (2)
    AssetLocation: NotRequired[AssetLocationTypeDef],  # (3)
  1. See AssetTypeType
  2. See ComputeAttributesTypeDef
  3. See AssetLocationTypeDef

CatalogItemTypeDef#

# CatalogItemTypeDef definition

class CatalogItemTypeDef(TypedDict):
    CatalogItemId: NotRequired[str],
    ItemStatus: NotRequired[CatalogItemStatusType],  # (1)
    EC2Capacities: NotRequired[List[EC2CapacityTypeDef]],  # (2)
    PowerKva: NotRequired[float],
    WeightLbs: NotRequired[int],
    SupportedUplinkGbps: NotRequired[List[int]],
    SupportedStorage: NotRequired[List[SupportedStorageEnumType]],  # (3)
  1. See CatalogItemStatusType
  2. See EC2CapacityTypeDef
  3. See SupportedStorageEnumType

CreateOrderInputRequestTypeDef#

# CreateOrderInputRequestTypeDef definition

class CreateOrderInputRequestTypeDef(TypedDict):
    OutpostIdentifier: str,
    LineItems: Sequence[LineItemRequestTypeDef],  # (1)
    PaymentOption: PaymentOptionType,  # (2)
    PaymentTerm: NotRequired[PaymentTermType],  # (3)
  1. See LineItemRequestTypeDef
  2. See PaymentOptionType
  3. See PaymentTermType

GetConnectionResponseTypeDef#

# GetConnectionResponseTypeDef definition

class GetConnectionResponseTypeDef(TypedDict):
    ConnectionId: str,
    ConnectionDetails: ConnectionDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionDetailsTypeDef
  2. See ResponseMetadataTypeDef

GetSiteAddressOutputTypeDef#

# GetSiteAddressOutputTypeDef definition

class GetSiteAddressOutputTypeDef(TypedDict):
    SiteId: str,
    AddressType: AddressTypeType,  # (1)
    Address: AddressTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AddressTypeType
  2. See AddressTypeDef
  3. See ResponseMetadataTypeDef

ListCapacityTasksOutputTypeDef#

# ListCapacityTasksOutputTypeDef definition

class ListCapacityTasksOutputTypeDef(TypedDict):
    CapacityTasks: List[CapacityTaskSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See