OutpostsClient

Index > Outposts > OutpostsClient

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

OutpostsClient

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

Usage example

from boto3.session import Session
from mypy_boto3_outposts.client import OutpostsClient

def get_outposts_client() -> OutpostsClient:
    return Session().client("outposts")

Exceptions

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

Usage example

client = boto3.client("outposts")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.NotFoundException,
    client.ServiceQuotaExceededException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_outposts.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("outposts").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_order

Cancels the specified order for an Outpost.

Type annotations and code completion for boto3.client("outposts").cancel_order method. boto3 documentation

Method definition

def cancel_order(
    self,
    *,
    OrderId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: CancelOrderInputRequestTypeDef = {  # (1)
    "OrderId": ...,
}

parent.cancel_order(**kwargs)

1. See CancelOrderInputRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("outposts").close method. boto3 documentation

Method definition

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

create_order

Creates an order for an Outpost.

Type annotations and code completion for boto3.client("outposts").create_order method. boto3 documentation

Method definition

def create_order(
    self,
    *,
    OutpostIdentifier: str,
    LineItems: Sequence[LineItemRequestTypeDef],  # (1)
    PaymentOption: PaymentOptionType,  # (2)
    PaymentTerm: PaymentTermType = ...,  # (3)
) -> CreateOrderOutputTypeDef:  # (4)
    ...

1. See LineItemRequestTypeDef
2. See PaymentOptionType
3. See PaymentTermType
4. See CreateOrderOutputTypeDef

Usage example with kwargs

kwargs: CreateOrderInputRequestTypeDef = {  # (1)
    "OutpostIdentifier": ...,
    "LineItems": ...,
    "PaymentOption": ...,
}

parent.create_order(**kwargs)

1. See CreateOrderInputRequestTypeDef

create_outpost

Creates an Outpost.

Type annotations and code completion for boto3.client("outposts").create_outpost method. boto3 documentation

Method definition

def create_outpost(
    self,
    *,
    Name: str,
    SiteId: str,
    Description: str = ...,
    AvailabilityZone: str = ...,
    AvailabilityZoneId: str = ...,
    Tags: Mapping[str, str] = ...,
    SupportedHardwareType: SupportedHardwareTypeType = ...,  # (1)
) -> CreateOutpostOutputTypeDef:  # (2)
    ...

1. See SupportedHardwareTypeType
2. See CreateOutpostOutputTypeDef

Usage example with kwargs

kwargs: CreateOutpostInputRequestTypeDef = {  # (1)
    "Name": ...,
    "SiteId": ...,
}

parent.create_outpost(**kwargs)

1. See CreateOutpostInputRequestTypeDef

create_site

Creates a site for an Outpost.

Type annotations and code completion for boto3.client("outposts").create_site method. boto3 documentation

Method definition

def create_site(
    self,
    *,
    Name: str,
    Description: str = ...,
    Notes: str = ...,
    Tags: Mapping[str, str] = ...,
    OperatingAddress: AddressTypeDef = ...,  # (1)
    ShippingAddress: AddressTypeDef = ...,  # (1)
    RackPhysicalProperties: RackPhysicalPropertiesTypeDef = ...,  # (3)
) -> CreateSiteOutputTypeDef:  # (4)
    ...

1. See AddressTypeDef
2. See AddressTypeDef
3. See RackPhysicalPropertiesTypeDef
4. See CreateSiteOutputTypeDef

Usage example with kwargs

kwargs: CreateSiteInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_site(**kwargs)

1. See CreateSiteInputRequestTypeDef

delete_outpost

Deletes the specified Outpost.

Type annotations and code completion for boto3.client("outposts").delete_outpost method. boto3 documentation

Method definition

def delete_outpost(
    self,
    *,
    OutpostId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_outpost(**kwargs)

1. See DeleteOutpostInputRequestTypeDef

delete_site

Deletes the specified site.

Type annotations and code completion for boto3.client("outposts").delete_site method. boto3 documentation

Method definition

def delete_site(
    self,
    *,
    SiteId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteSiteInputRequestTypeDef = {  # (1)
    "SiteId": ...,
}

parent.delete_site(**kwargs)

1. See DeleteSiteInputRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("outposts").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_catalog_item

Gets information about the specified catalog item.

Type annotations and code completion for boto3.client("outposts").get_catalog_item method. boto3 documentation

Method definition

def get_catalog_item(
    self,
    *,
    CatalogItemId: str,
) -> GetCatalogItemOutputTypeDef:  # (1)
    ...

1. See GetCatalogItemOutputTypeDef

Usage example with kwargs

kwargs: GetCatalogItemInputRequestTypeDef = {  # (1)
    "CatalogItemId": ...,
}

parent.get_catalog_item(**kwargs)

1. See GetCatalogItemInputRequestTypeDef

get_connection

.

Type annotations and code completion for boto3.client("outposts").get_connection method. boto3 documentation

Method definition

def get_connection(
    self,
    *,
    ConnectionId: str,
) -> GetConnectionResponseTypeDef:  # (1)
    ...

1. See GetConnectionResponseTypeDef

Usage example with kwargs

kwargs: GetConnectionRequestRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.get_connection(**kwargs)

1. See GetConnectionRequestRequestTypeDef

get_order

Gets information about the specified order.

Type annotations and code completion for boto3.client("outposts").get_order method. boto3 documentation

Method definition

def get_order(
    self,
    *,
    OrderId: str,
) -> GetOrderOutputTypeDef:  # (1)
    ...

1. See GetOrderOutputTypeDef

Usage example with kwargs

kwargs: GetOrderInputRequestTypeDef = {  # (1)
    "OrderId": ...,
}

parent.get_order(**kwargs)

1. See GetOrderInputRequestTypeDef

get_outpost

Gets information about the specified Outpost.

Type annotations and code completion for boto3.client("outposts").get_outpost method. boto3 documentation

Method definition

def get_outpost(
    self,
    *,
    OutpostId: str,
) -> GetOutpostOutputTypeDef:  # (1)
    ...

1. See GetOutpostOutputTypeDef

Usage example with kwargs

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

parent.get_outpost(**kwargs)

1. See GetOutpostInputRequestTypeDef

get_outpost_instance_types

Gets the instance types for the specified Outpost.

Type annotations and code completion for boto3.client("outposts").get_outpost_instance_types method. boto3 documentation

Method definition

def get_outpost_instance_types(
    self,
    *,
    OutpostId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetOutpostInstanceTypesOutputTypeDef:  # (1)
    ...

1. See GetOutpostInstanceTypesOutputTypeDef

Usage example with kwargs

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

parent.get_outpost_instance_types(**kwargs)

1. See GetOutpostInstanceTypesInputRequestTypeDef

get_site

Gets information about the specified Outpost site.

Type annotations and code completion for boto3.client("outposts").get_site method. boto3 documentation

Method definition

def get_site(
    self,
    *,
    SiteId: str,
) -> GetSiteOutputTypeDef:  # (1)
    ...

1. See GetSiteOutputTypeDef

Usage example with kwargs

kwargs: GetSiteInputRequestTypeDef = {  # (1)
    "SiteId": ...,
}

parent.get_site(**kwargs)

1. See GetSiteInputRequestTypeDef

get_site_address

Gets the site address of the specified site.

Type annotations and code completion for boto3.client("outposts").get_site_address method. boto3 documentation

Method definition

def get_site_address(
    self,
    *,
    SiteId: str,
    AddressType: AddressTypeType,  # (1)
) -> GetSiteAddressOutputTypeDef:  # (2)
    ...

1. See AddressTypeType
2. See GetSiteAddressOutputTypeDef

Usage example with kwargs

kwargs: GetSiteAddressInputRequestTypeDef = {  # (1)
    "SiteId": ...,
    "AddressType": ...,
}

parent.get_site_address(**kwargs)

1. See GetSiteAddressInputRequestTypeDef

list_assets

Lists the hardware assets for the specified Outpost.

Type annotations and code completion for boto3.client("outposts").list_assets method. boto3 documentation

Method definition

def list_assets(
    self,
    *,
    OutpostIdentifier: str,
    HostIdFilter: Sequence[str] = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    StatusFilter: Sequence[AssetStateType] = ...,  # (1)
) -> ListAssetsOutputTypeDef:  # (2)
    ...

1. See AssetStateType
2. See ListAssetsOutputTypeDef

Usage example with kwargs

kwargs: ListAssetsInputRequestTypeDef = {  # (1)
    "OutpostIdentifier": ...,
}

parent.list_assets(**kwargs)

1. See ListAssetsInputRequestTypeDef

list_catalog_items

Lists the items in the catalog.

Type annotations and code completion for boto3.client("outposts").list_catalog_items method. boto3 documentation

Method definition

def list_catalog_items(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ItemClassFilter: Sequence[CatalogItemClassType] = ...,  # (1)
    SupportedStorageFilter: Sequence[SupportedStorageEnumType] = ...,  # (2)
    EC2FamilyFilter: Sequence[str] = ...,
) -> ListCatalogItemsOutputTypeDef:  # (3)
    ...

1. See CatalogItemClassType
2. See SupportedStorageEnumType
3. See ListCatalogItemsOutputTypeDef

Usage example with kwargs

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

parent.list_catalog_items(**kwargs)

1. See ListCatalogItemsInputRequestTypeDef

list_orders

Lists the Outpost orders for your Amazon Web Services account.

Type annotations and code completion for boto3.client("outposts").list_orders method. boto3 documentation

Method definition

def list_orders(
    self,
    *,
    OutpostIdentifierFilter: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListOrdersOutputTypeDef:  # (1)
    ...

1. See ListOrdersOutputTypeDef

Usage example with kwargs

kwargs: ListOrdersInputRequestTypeDef = {  # (1)
    "OutpostIdentifierFilter": ...,
}

parent.list_orders(**kwargs)

1. See ListOrdersInputRequestTypeDef

list_outposts

Lists the Outposts for your Amazon Web Services account.

Type annotations and code completion for boto3.client("outposts").list_outposts method. boto3 documentation

Method definition

def list_outposts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    LifeCycleStatusFilter: Sequence[str] = ...,
    AvailabilityZoneFilter: Sequence[str] = ...,
    AvailabilityZoneIdFilter: Sequence[str] = ...,
) -> ListOutpostsOutputTypeDef:  # (1)
    ...

1. See ListOutpostsOutputTypeDef

Usage example with kwargs

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

parent.list_outposts(**kwargs)

1. See ListOutpostsInputRequestTypeDef

list_sites

Lists the Outpost sites for your Amazon Web Services account.

Type annotations and code completion for boto3.client("outposts").list_sites method. boto3 documentation

Method definition

def list_sites(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    OperatingAddressCountryCodeFilter: Sequence[str] = ...,
    OperatingAddressStateOrRegionFilter: Sequence[str] = ...,
    OperatingAddressCityFilter: Sequence[str] = ...,
) -> ListSitesOutputTypeDef:  # (1)
    ...

1. See ListSitesOutputTypeDef

Usage example with kwargs

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

parent.list_sites(**kwargs)

1. See ListSitesInputRequestTypeDef

list_tags_for_resource

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("outposts").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

start_connection

.

Type annotations and code completion for boto3.client("outposts").start_connection method. boto3 documentation

Method definition

def start_connection(
    self,
    *,
    DeviceSerialNumber: str,
    AssetId: str,
    ClientPublicKey: str,
    NetworkInterfaceDeviceIndex: int,
) -> StartConnectionResponseTypeDef:  # (1)
    ...

1. See StartConnectionResponseTypeDef

Usage example with kwargs

kwargs: StartConnectionRequestRequestTypeDef = {  # (1)
    "DeviceSerialNumber": ...,
    "AssetId": ...,
    "ClientPublicKey": ...,
    "NetworkInterfaceDeviceIndex": ...,
}

parent.start_connection(**kwargs)

1. See StartConnectionRequestRequestTypeDef

tag_resource

Adds tags to the specified resource.

Type annotations and code completion for boto3.client("outposts").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from the specified resource.

Type annotations and code completion for boto3.client("outposts").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_outpost

Updates an Outpost.

Type annotations and code completion for boto3.client("outposts").update_outpost method. boto3 documentation

Method definition

def update_outpost(
    self,
    *,
    OutpostId: str,
    Name: str = ...,
    Description: str = ...,
    SupportedHardwareType: SupportedHardwareTypeType = ...,  # (1)
) -> UpdateOutpostOutputTypeDef:  # (2)
    ...

1. See SupportedHardwareTypeType
2. See UpdateOutpostOutputTypeDef

Usage example with kwargs

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

parent.update_outpost(**kwargs)

1. See UpdateOutpostInputRequestTypeDef

update_site

Updates the specified site.

Type annotations and code completion for boto3.client("outposts").update_site method. boto3 documentation

Method definition

def update_site(
    self,
    *,
    SiteId: str,
    Name: str = ...,
    Description: str = ...,
    Notes: str = ...,
) -> UpdateSiteOutputTypeDef:  # (1)
    ...

1. See UpdateSiteOutputTypeDef

Usage example with kwargs

kwargs: UpdateSiteInputRequestTypeDef = {  # (1)
    "SiteId": ...,
}

parent.update_site(**kwargs)

1. See UpdateSiteInputRequestTypeDef

update_site_address

Updates the address of the specified site.

Type annotations and code completion for boto3.client("outposts").update_site_address method. boto3 documentation

Method definition

def update_site_address(
    self,
    *,
    SiteId: str,
    AddressType: AddressTypeType,  # (1)
    Address: AddressTypeDef,  # (2)
) -> UpdateSiteAddressOutputTypeDef:  # (3)
    ...

1. See AddressTypeType
2. See AddressTypeDef
3. See UpdateSiteAddressOutputTypeDef

Usage example with kwargs

kwargs: UpdateSiteAddressInputRequestTypeDef = {  # (1)
    "SiteId": ...,
    "AddressType": ...,
    "Address": ...,
}

parent.update_site_address(**kwargs)

1. See UpdateSiteAddressInputRequestTypeDef

update_site_rack_physical_properties

Update the physical and logistical details for a rack at a site.

Type annotations and code completion for boto3.client("outposts").update_site_rack_physical_properties method. boto3 documentation

Method definition

def update_site_rack_physical_properties(
    self,
    *,
    SiteId: str,
    PowerDrawKva: PowerDrawKvaType = ...,  # (1)
    PowerPhase: PowerPhaseType = ...,  # (2)
    PowerConnector: PowerConnectorType = ...,  # (3)
    PowerFeedDrop: PowerFeedDropType = ...,  # (4)
    UplinkGbps: UplinkGbpsType = ...,  # (5)
    UplinkCount: UplinkCountType = ...,  # (6)
    FiberOpticCableType: FiberOpticCableTypeType = ...,  # (7)
    OpticalStandard: OpticalStandardType = ...,  # (8)
    MaximumSupportedWeightLbs: MaximumSupportedWeightLbsType = ...,  # (9)
) -> UpdateSiteRackPhysicalPropertiesOutputTypeDef:  # (10)
    ...

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
10. See UpdateSiteRackPhysicalPropertiesOutputTypeDef

Usage example with kwargs

kwargs: UpdateSiteRackPhysicalPropertiesInputRequestTypeDef = {  # (1)
    "SiteId": ...,
}

parent.update_site_rack_physical_properties(**kwargs)

1. See UpdateSiteRackPhysicalPropertiesInputRequestTypeDef