Skip to content

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

# OutpostsClient 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.

# Exceptions.exceptions usage example

client = boto3.client("outposts")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions 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

# can_paginate 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

# cancel_order method definition

def cancel_order(
    self,
    *,
    OrderId: str,
) -> Dict[str, Any]:
    ...
# cancel_order method usage example with argument unpacking

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

# close 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

# create_order 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 
# create_order method usage example with argument unpacking

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

# create_outpost 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 
# create_outpost method usage example with argument unpacking

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

# create_site 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 
# create_site method usage example with argument unpacking

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

# delete_outpost method definition

def delete_outpost(
    self,
    *,
    OutpostId: str,
) -> Dict[str, Any]:
    ...
# delete_outpost method usage example with argument unpacking

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

# delete_site method definition

def delete_site(
    self,
    *,
    SiteId: str,
) -> Dict[str, Any]:
    ...
# delete_site method usage example with argument unpacking

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

# generate_presigned_url 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

# get_catalog_item method definition

def get_catalog_item(
    self,
    *,
    CatalogItemId: str,
) -> GetCatalogItemOutputTypeDef:  # (1)
    ...
  1. See GetCatalogItemOutputTypeDef 
# get_catalog_item method usage example with argument unpacking

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

# get_connection method definition

def get_connection(
    self,
    *,
    ConnectionId: str,
) -> GetConnectionResponseTypeDef:  # (1)
    ...
  1. See GetConnectionResponseTypeDef 
# get_connection method usage example with argument unpacking

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

# get_order method definition

def get_order(
    self,
    *,
    OrderId: str,
) -> GetOrderOutputTypeDef:  # (1)
    ...
  1. See GetOrderOutputTypeDef 
# get_order method usage example with argument unpacking

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

# get_outpost method definition

def get_outpost(
    self,
    *,
    OutpostId: str,
) -> GetOutpostOutputTypeDef:  # (1)
    ...
  1. See GetOutpostOutputTypeDef 
# get_outpost method usage example with argument unpacking

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

# get_outpost_instance_types method definition

def get_outpost_instance_types(
    self,
    *,
    OutpostId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetOutpostInstanceTypesOutputTypeDef:  # (1)
    ...
  1. See GetOutpostInstanceTypesOutputTypeDef 
# get_outpost_instance_types method usage example with argument unpacking

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

# get_site method definition

def get_site(
    self,
    *,
    SiteId: str,
) -> GetSiteOutputTypeDef:  # (1)
    ...
  1. See GetSiteOutputTypeDef 
# get_site method usage example with argument unpacking

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

# get_site_address method definition

def get_site_address(
    self,
    *,
    SiteId: str,
    AddressType: AddressTypeType,  # (1)
) -> GetSiteAddressOutputTypeDef:  # (2)
    ...
  1. See AddressTypeType
  2. See GetSiteAddressOutputTypeDef 
# get_site_address method usage example with argument unpacking

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

# list_assets 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 
# list_assets method usage example with argument unpacking

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

# list_catalog_items 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 
# list_catalog_items method usage example with argument unpacking

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

# list_orders method definition

def list_orders(
    self,
    *,
    OutpostIdentifierFilter: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListOrdersOutputTypeDef:  # (1)
    ...
  1. See ListOrdersOutputTypeDef 
# list_orders method usage example with argument unpacking

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

# list_outposts method definition

def list_outposts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    LifeCycleStatusFilter: Sequence[str] = ...,
    AvailabilityZoneFilter: Sequence[str] = ...,
    AvailabilityZoneIdFilter: Sequence[str] = ...,
) -> ListOutpostsOutputTypeDef:  # (1)
    ...
  1. See ListOutpostsOutputTypeDef 
# list_outposts method usage example with argument unpacking

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

# list_sites method definition

def list_sites(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    OperatingAddressCountryCodeFilter: Sequence[str] = ...,
    OperatingAddressStateOrRegionFilter: Sequence[str] = ...,
    OperatingAddressCityFilter: Sequence[str] = ...,
) -> ListSitesOutputTypeDef:  # (1)
    ...
  1. See ListSitesOutputTypeDef 
# list_sites method usage example with argument unpacking

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_connection#</