Outposts ¶

Table of Contents

Outposts
- Client
- Paginators

Client ¶

class Outposts.Client¶

A low-level client representing AWS Outposts

Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.

import boto3

client = boto3.client('outposts')

These are the available methods:

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

cancel_order(**kwargs)¶

Cancels the specified order for an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.cancel_order(
    OrderId='string'
)

Parameters

OrderId (string) --

[REQUIRED]

The ID of the order.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

close()¶: Closes underlying endpoint connections.

create_order(**kwargs)¶

Creates an order for an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.create_order(
    OutpostIdentifier='string',
    LineItems=[
        {
            'CatalogItemId': 'string',
            'Quantity': 123
        },
    ],
    PaymentOption='ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
    PaymentTerm='THREE_YEARS'|'ONE_YEAR'
)

Parameters

OutpostIdentifier (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.
LineItems (list) --
[REQUIRED]

The line items that make up the order.
- (dict) --
  Information about a line item request.
  - CatalogItemId (string) --
    The ID of the catalog item.
  - Quantity (integer) --
    The quantity of a line item request.
PaymentOption (string) --
[REQUIRED]

The payment option.
PaymentTerm (string) -- The payment terms.

Return type

dict

Returns

Response Syntax

{
    'Order': {
        'OutpostId': 'string',
        'OrderId': 'string',
        'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
        'LineItems': [
            {
                'CatalogItemId': 'string',
                'LineItemId': 'string',
                'Quantity': 123,
                'Status': 'PREPARING'|'BUILDING'|'SHIPPED'|'DELIVERED'|'INSTALLING'|'INSTALLED'|'ERROR'|'CANCELLED'|'REPLACED',
                'ShipmentInformation': {
                    'ShipmentTrackingNumber': 'string',
                    'ShipmentCarrier': 'DHL'|'DBS'|'FEDEX'|'UPS'
                },
                'AssetInformationList': [
                    {
                        'AssetId': 'string',
                        'MacAddressList': [
                            'string',
                        ]
                    },
                ],
                'PreviousLineItemId': 'string',
                'PreviousOrderId': 'string'
            },
        ],
        'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        'OrderSubmissionDate': datetime(2015, 1, 1),
        'OrderFulfilledDate': datetime(2015, 1, 1),
        'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR',
        'OrderType': 'OUTPOST'|'REPLACEMENT'
    }
}

Response Structure

(dict) --
- Order (dict) --
  
  Information about this order.
  - OutpostId (string) --
    
    The ID of the Outpost in the order.
  - OrderId (string) --
    
    The ID of the order.
  - Status (string) --
    
    The status of the order.
    - PREPARING - Order is received and being prepared.
    - IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.
    - COMPLETED - Order is complete.
    - CANCELLED - Order is cancelled.
    - ERROR - Customer should contact support.
    Note
    
    The following status are deprecated: RECEIVED , PENDING , PROCESSING , INSTALLING , and FULFILLED .
  - LineItems (list) --
    
    The line items for the order
    - (dict) --
      
      Information about a line item.
      - CatalogItemId (string) --
        
        The ID of the catalog item.
      - LineItemId (string) --
        
        The ID of the line item.
      - Quantity (integer) --
        
        The quantity of the line item.
      - Status (string) --
        
        The status of the line item.
      - ShipmentInformation (dict) --
        
        Information about a line item shipment.
        
        ShipmentTrackingNumber (string) --
        
        The tracking number of the shipment.
        
        ShipmentCarrier (string) --
        
        The carrier of the shipment.
      - AssetInformationList (list) --
        
        Information about assets.
        
        (dict) --
        
        Information about a line item asset.
        
        AssetId (string) --
        
        The ID of the asset.
        
        MacAddressList (list) --
        
        The MAC addresses of the asset.
        
        (string) --
      - PreviousLineItemId (string) --
        
        The ID of the previous line item.
      - PreviousOrderId (string) --
        
        The ID of the previous order.
  - PaymentOption (string) --
    
    The payment option for the order.
  - OrderSubmissionDate (datetime) --
    
    The submission date for the order.
  - OrderFulfilledDate (datetime) --
    
    The fulfillment date of the order.
  - PaymentTerm (string) --
    
    The payment term.
  - OrderType (string) --
    
    The type of order.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ServiceQuotaExceededException

create_outpost(**kwargs)¶

Creates an Outpost.

You can specify either an Availability one or an AZ ID.

See also: AWS API Documentation

Request Syntax

response = client.create_outpost(
    Name='string',
    Description='string',
    SiteId='string',
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    Tags={
        'string': 'string'
    },
    SupportedHardwareType='RACK'|'SERVER'
)

Parameters

Name (string) --
[REQUIRED]

The name of the Outpost.
Description (string) -- The description of the Outpost.
SiteId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.
AvailabilityZone (string) -- The Availability Zone.
AvailabilityZoneId (string) -- The ID of the Availability Zone.
Tags (dict) --
The tags to apply to the Outpost.
- (string) --
  - (string) --
SupportedHardwareType (string) -- The type of hardware for this Outpost.

Return type

dict

Returns

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER'
    }
}

Response Structure

(dict) --
- Outpost (dict) --
  
  Information about an Outpost.
  - OutpostId (string) --
    
    The ID of the Outpost.
  - OwnerId (string) --
    
    The Amazon Web Services account ID of the Outpost owner.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost.
  - SiteId (string) --
    
    The ID of the site.
  - Name (string) --
    
    The name of the Outpost.
  - Description (string) --
    
    The description of the Outpost.
  - LifeCycleStatus (string) --
    
    The life cycle status.
  - AvailabilityZone (string) --
    
    The Availability Zone.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone.
  - Tags (dict) --
    
    The Outpost tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - SupportedHardwareType (string) --
    
    The hardware type.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ServiceQuotaExceededException

create_site(**kwargs)¶

Creates a site for an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.create_site(
    Name='string',
    Description='string',
    Notes='string',
    Tags={
        'string': 'string'
    },
    OperatingAddress={
        'ContactName': 'string',
        'ContactPhoneNumber': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'StateOrRegion': 'string',
        'DistrictOrCounty': 'string',
        'PostalCode': 'string',
        'CountryCode': 'string',
        'Municipality': 'string'
    },
    ShippingAddress={
        'ContactName': 'string',
        'ContactPhoneNumber': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'StateOrRegion': 'string',
        'DistrictOrCounty': 'string',
        'PostalCode': 'string',
        'CountryCode': 'string',
        'Municipality': 'string'
    },
    RackPhysicalProperties={
        'PowerDrawKva': 'POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
        'PowerPhase': 'SINGLE_PHASE'|'THREE_PHASE',
        'PowerConnector': 'L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
        'PowerFeedDrop': 'ABOVE_RACK'|'BELOW_RACK',
        'UplinkGbps': 'UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
        'UplinkCount': 'UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
        'FiberOpticCableType': 'SINGLE_MODE'|'MULTI_MODE',
        'OpticalStandard': 'OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
        'MaximumSupportedWeightLbs': 'NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
    }
)

Parameters

Name (string) --
[REQUIRED]

The name of the site.
Description (string) -- The description of the site.
Notes (string) -- Additional information that you provide about site access requirements, electrician scheduling, personal protective equipment, or regulation of equipment materials that could affect your installation process.
Tags (dict) --
The tags to apply to a site.
- (string) --
  - (string) --
OperatingAddress (dict) --
The location to install and power on the hardware. This address might be different from the shipping address.
- ContactName (string) --
  The name of the contact.
- ContactPhoneNumber (string) --
  The phone number of the contact.
- AddressLine1 (string) -- [REQUIRED]
  The first line of the address.
- AddressLine2 (string) --
  The second line of the address.
- AddressLine3 (string) --
  The third line of the address.
- City (string) -- [REQUIRED]
  The city for the address.
- StateOrRegion (string) -- [REQUIRED]
  The state for the address.
- DistrictOrCounty (string) --
  The district or county for the address.
- PostalCode (string) -- [REQUIRED]
  The postal code for the address.
- CountryCode (string) -- [REQUIRED]
  The ISO-3166 two-letter country code for the address.
- Municipality (string) --
  The municipality for the address.
ShippingAddress (dict) --
The location to ship the hardware. This address might be different from the operating address.
- ContactName (string) --
  The name of the contact.
- ContactPhoneNumber (string) --
  The phone number of the contact.
- AddressLine1 (string) -- [REQUIRED]
  The first line of the address.
- AddressLine2 (string) --
  The second line of the address.
- AddressLine3 (string) --
  The third line of the address.
- City (string) -- [REQUIRED]
  The city for the address.
- StateOrRegion (string) -- [REQUIRED]
  The state for the address.
- DistrictOrCounty (string) --
  The district or county for the address.
- PostalCode (string) -- [REQUIRED]
  The postal code for the address.
- CountryCode (string) -- [REQUIRED]
  The ISO-3166 two-letter country code for the address.
- Municipality (string) --
  The municipality for the address.
RackPhysicalProperties (dict) --
Information about the physical and logistical details for the rack at this site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.
- PowerDrawKva (string) --
  The power draw available at the hardware placement position for the rack.
- PowerPhase (string) --
  The power option that you can provide for hardware.
- PowerConnector (string) --
  The power connector for the hardware.
- PowerFeedDrop (string) --
  The position of the power feed.
- UplinkGbps (string) --
  The uplink speed the rack supports for the connection to the Region.
- UplinkCount (string) --
  The number of uplinks each Outpost network device.
- FiberOpticCableType (string) --
  The type of fiber used to attach the Outpost to the network.
- OpticalStandard (string) --
  The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
- MaximumSupportedWeightLbs (string) --
  The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'Notes': 'string',
        'OperatingAddressCountryCode': 'string',
        'OperatingAddressStateOrRegion': 'string',
        'OperatingAddressCity': 'string',
        'RackPhysicalProperties': {
            'PowerDrawKva': 'POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
            'PowerPhase': 'SINGLE_PHASE'|'THREE_PHASE',
            'PowerConnector': 'L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
            'PowerFeedDrop': 'ABOVE_RACK'|'BELOW_RACK',
            'UplinkGbps': 'UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
            'UplinkCount': 'UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
            'FiberOpticCableType': 'SINGLE_MODE'|'MULTI_MODE',
            'OpticalStandard': 'OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
            'MaximumSupportedWeightLbs': 'NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
        }
    }
}

Response Structure

(dict) --
- Site (dict) --
  
  Information about a site.
  - SiteId (string) --
    
    The ID of the site.
  - AccountId (string) --
    
    The ID of the Amazon Web Services account.
  - Name (string) --
    
    The name of the site.
  - Description (string) --
    
    The description of the site.
  - Tags (dict) --
    
    The site tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - Notes (string) --
    
    Notes about a site.
  - OperatingAddressCountryCode (string) --
    
    The ISO-3166 two-letter country code where the hardware is installed and powered on.
  - OperatingAddressStateOrRegion (string) --
    
    State or region where the hardware is installed and powered on.
  - OperatingAddressCity (string) --
    
    City where the hardware is installed and powered on.
  - RackPhysicalProperties (dict) --
    
    Information about the physical and logistical details for a rack at the site.
    - PowerDrawKva (string) --
      
      The power draw available at the hardware placement position for the rack.
    - PowerPhase (string) --
      
      The power option that you can provide for hardware.
    - PowerConnector (string) --
      
      The power connector for the hardware.
    - PowerFeedDrop (string) --
      
      The position of the power feed.
    - UplinkGbps (string) --
      
      The uplink speed the rack supports for the connection to the Region.
    - UplinkCount (string) --
      
      The number of uplinks each Outpost network device.
    - FiberOpticCableType (string) --
      
      The type of fiber used to attach the Outpost to the network.
    - OpticalStandard (string) --
      
      The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
    - MaximumSupportedWeightLbs (string) --
      
      The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ServiceQuotaExceededException

delete_outpost(**kwargs)¶

Deletes the specified Outpost.

See also: AWS API Documentation

Request Syntax

response = client.delete_outpost(
    OutpostId='string'
)

Parameters

OutpostId (string) --

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

delete_site(**kwargs)¶

Deletes the specified site.

See also: AWS API Documentation

Request Syntax

response = client.delete_site(
    SiteId='string'
)

Parameters

SiteId (string) --

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_catalog_item(**kwargs)¶

Gets information about the specified catalog item.

See also: AWS API Documentation

Request Syntax

response = client.get_catalog_item(
    CatalogItemId='string'
)

Parameters

CatalogItemId (string) --

[REQUIRED]

The ID of the catalog item.

Return type

dict

Returns

Response Syntax

{
    'CatalogItem': {
        'CatalogItemId': 'string',
        'ItemStatus': 'AVAILABLE'|'DISCONTINUED',
        'EC2Capacities': [
            {
                'Family': 'string',
                'MaxSize': 'string',
                'Quantity': 'string'
            },
        ],
        'PowerKva': ...,
        'WeightLbs': 123,
        'SupportedUplinkGbps': [
            123,
        ],
        'SupportedStorage': [
            'EBS'|'S3',
        ]
    }
}

Response Structure

(dict) --
- CatalogItem (dict) --
  Information about this catalog item.
  - CatalogItemId (string) --
    The ID of the catalog item.
  - ItemStatus (string) --
    The status of a catalog item.
  - EC2Capacities (list) --
    Information about the EC2 capacity of an item.
    - (dict) --
      Information about EC2 capacity.
      - Family (string) --
        The family of the EC2 capacity.
      - MaxSize (string) --
        The maximum size of the EC2 capacity.
      - Quantity (string) --
        The quantity of the EC2 capacity.
  - PowerKva (float) --
    Information about the power draw of an item.
  - WeightLbs (integer) --
    The weight of the item in pounds.
  - SupportedUplinkGbps (list) --
    The uplink speed this catalog item requires for the connection to the Region.
    - (integer) --
  - SupportedStorage (list) --
    The supported storage options for the catalog item.
    - (string) --

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

get_connection(**kwargs)¶

Note

Amazon Web Services uses this action to install Outpost servers.

Gets information about the specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_connection(
    ConnectionId='string'
)

Parameters

ConnectionId (string) --

[REQUIRED]

The ID of the connection.

Return type

dict

Returns

Response Syntax

{
    'ConnectionId': 'string',
    'ConnectionDetails': {
        'ClientPublicKey': 'string',
        'ServerPublicKey': 'string',
        'ServerEndpoint': 'string',
        'ClientTunnelAddress': 'string',
        'ServerTunnelAddress': 'string',
        'AllowedIps': [
            'string',
        ]
    }
}

Response Structure

(dict) --
- ConnectionId (string) --
  The ID of the connection.
- ConnectionDetails (dict) --
  Information about the connection.
  - ClientPublicKey (string) --
    The public key of the client.
  - ServerPublicKey (string) --
    The public key of the server.
  - ServerEndpoint (string) --
    The endpoint for the server.
  - ClientTunnelAddress (string) --
    The client tunnel address.
  - ServerTunnelAddress (string) --
    The server tunnel address.
  - AllowedIps (list) --
    The allowed IP addresses.
    - (string) --

Exceptions

Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

get_order(**kwargs)¶

Gets information about the specified order.

See also: AWS API Documentation

Request Syntax

response = client.get_order(
    OrderId='string'
)

Parameters

OrderId (string) --

[REQUIRED]

The ID of the order.

Return type

dict

Returns

Response Syntax

{
    'Order': {
        'OutpostId': 'string',
        'OrderId': 'string',
        'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
        'LineItems': [
            {
                'CatalogItemId': 'string',
                'LineItemId': 'string',
                'Quantity': 123,
                'Status': 'PREPARING'|'BUILDING'|'SHIPPED'|'DELIVERED'|'INSTALLING'|'INSTALLED'|'ERROR'|'CANCELLED'|'REPLACED',
                'ShipmentInformation': {
                    'ShipmentTrackingNumber': 'string',
                    'ShipmentCarrier': 'DHL'|'DBS'|'FEDEX'|'UPS'
                },
                'AssetInformationList': [
                    {
                        'AssetId': 'string',
                        'MacAddressList': [
                            'string',
                        ]
                    },
                ],
                'PreviousLineItemId': 'string',
                'PreviousOrderId': 'string'
            },
        ],
        'PaymentOption': 'ALL_UPFRONT'|'NO_UPFRONT'|'PARTIAL_UPFRONT',
        'OrderSubmissionDate': datetime(2015, 1, 1),
        'OrderFulfilledDate': datetime(2015, 1, 1),
        'PaymentTerm': 'THREE_YEARS'|'ONE_YEAR',
        'OrderType': 'OUTPOST'|'REPLACEMENT'
    }
}

Response Structure

(dict) --
- Order (dict) --
  Information about an order.
  - OutpostId (string) --
    The ID of the Outpost in the order.
  - OrderId (string) --
    The ID of the order.
  - Status (string) --
    The status of the order.
    - PREPARING - Order is received and being prepared.
    - IN_PROGRESS - Order is either being built, shipped, or installed. To get more details, see the line item status.
    - COMPLETED - Order is complete.
    - CANCELLED - Order is cancelled.
    - ERROR - Customer should contact support.
    Note
    
    The following status are deprecated: RECEIVED , PENDING , PROCESSING , INSTALLING , and FULFILLED .
  - LineItems (list) --
    The line items for the order
    - (dict) --
      Information about a line item.
      - CatalogItemId (string) --
        The ID of the catalog item.
      - LineItemId (string) --
        The ID of the line item.
      - Quantity (integer) --
        The quantity of the line item.
      - Status (string) --
        The status of the line item.
      - ShipmentInformation (dict) --
        Information about a line item shipment.
        
        ShipmentTrackingNumber (string) --
        The tracking number of the shipment.
        
        ShipmentCarrier (string) --
        The carrier of the shipment.
      - AssetInformationList (list) --
        Information about assets.
        
        (dict) --
        Information about a line item asset.
        
        AssetId (string) --
        The ID of the asset.
        
        MacAddressList (list) --
        The MAC addresses of the asset.
        
        (string) --
      - PreviousLineItemId (string) --
        The ID of the previous line item.
      - PreviousOrderId (string) --
        The ID of the previous order.
  - PaymentOption (string) --
    The payment option for the order.
  - OrderSubmissionDate (datetime) --
    The submission date for the order.
  - OrderFulfilledDate (datetime) --
    The fulfillment date of the order.
  - PaymentTerm (string) --
    The payment term.
  - OrderType (string) --
    The type of order.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

get_outpost(**kwargs)¶

Gets information about the specified Outpost.

See also: AWS API Documentation

Request Syntax

response = client.get_outpost(
    OutpostId='string'
)

Parameters

OutpostId (string) --

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.

Return type

dict

Returns

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER'
    }
}

Response Structure

(dict) --
- Outpost (dict) --
  Information about an Outpost.
  - OutpostId (string) --
    The ID of the Outpost.
  - OwnerId (string) --
    The Amazon Web Services account ID of the Outpost owner.
  - OutpostArn (string) --
    The Amazon Resource Name (ARN) of the Outpost.
  - SiteId (string) --
    The ID of the site.
  - Name (string) --
    The name of the Outpost.
  - Description (string) --
    The description of the Outpost.
  - LifeCycleStatus (string) --
    The life cycle status.
  - AvailabilityZone (string) --
    The Availability Zone.
  - AvailabilityZoneId (string) --
    The ID of the Availability Zone.
  - Tags (dict) --
    The Outpost tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    The Amazon Resource Name (ARN) of the site.
  - SupportedHardwareType (string) --
    The hardware type.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_outpost_instance_types(**kwargs)¶

Gets the instance types for the specified Outpost.

See also: AWS API Documentation

Request Syntax

response = client.get_outpost_instance_types(
    OutpostId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

OutpostId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.
NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.

Return type

dict

Returns

Response Syntax

{
    'InstanceTypes': [
        {
            'InstanceType': 'string'
        },
    ],
    'NextToken': 'string',
    'OutpostId': 'string',
    'OutpostArn': 'string'
}

Response Structure

(dict) --
- InstanceTypes (list) --
  
  Information about the instance types.
  - (dict) --
    
    Information about an instance type.
    - InstanceType (string) --
      
      The instance type.
- NextToken (string) --
  
  The pagination token.
- OutpostId (string) --
  
  The ID of the Outpost.
- OutpostArn (string) --
  
  The Amazon Resource Name (ARN) of the Outpost.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_site(**kwargs)¶

Gets information about the specified Outpost site.

See also: AWS API Documentation

Request Syntax

response = client.get_site(
    SiteId='string'
)

Parameters

SiteId (string) --

[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'Notes': 'string',
        'OperatingAddressCountryCode': 'string',
        'OperatingAddressStateOrRegion': 'string',
        'OperatingAddressCity': 'string',
        'RackPhysicalProperties': {
            'PowerDrawKva': 'POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
            'PowerPhase': 'SINGLE_PHASE'|'THREE_PHASE',
            'PowerConnector': 'L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
            'PowerFeedDrop': 'ABOVE_RACK'|'BELOW_RACK',
            'UplinkGbps': 'UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
            'UplinkCount': 'UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
            'FiberOpticCableType': 'SINGLE_MODE'|'MULTI_MODE',
            'OpticalStandard': 'OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
            'MaximumSupportedWeightLbs': 'NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
        }
    }
}

Response Structure

(dict) --
- Site (dict) --
  Information about a site.
  - SiteId (string) --
    The ID of the site.
  - AccountId (string) --
    The ID of the Amazon Web Services account.
  - Name (string) --
    The name of the site.
  - Description (string) --
    The description of the site.
  - Tags (dict) --
    The site tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    The Amazon Resource Name (ARN) of the site.
  - Notes (string) --
    Notes about a site.
  - OperatingAddressCountryCode (string) --
    The ISO-3166 two-letter country code where the hardware is installed and powered on.
  - OperatingAddressStateOrRegion (string) --
    State or region where the hardware is installed and powered on.
  - OperatingAddressCity (string) --
    City where the hardware is installed and powered on.
  - RackPhysicalProperties (dict) --
    Information about the physical and logistical details for a rack at the site.
    - PowerDrawKva (string) --
      The power draw available at the hardware placement position for the rack.
    - PowerPhase (string) --
      The power option that you can provide for hardware.
    - PowerConnector (string) --
      The power connector for the hardware.
    - PowerFeedDrop (string) --
      The position of the power feed.
    - UplinkGbps (string) --
      The uplink speed the rack supports for the connection to the Region.
    - UplinkCount (string) --
      The number of uplinks each Outpost network device.
    - FiberOpticCableType (string) --
      The type of fiber used to attach the Outpost to the network.
    - OpticalStandard (string) --
      The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
    - MaximumSupportedWeightLbs (string) --
      The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

get_site_address(**kwargs)¶

Gets the site address of the specified site.

See also: AWS API Documentation

Request Syntax

response = client.get_site_address(
    SiteId='string',
    AddressType='SHIPPING_ADDRESS'|'OPERATING_ADDRESS'
)

Parameters

SiteId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.
AddressType (string) --
[REQUIRED]

The type of the address you request.

Return type

dict

Returns

Response Syntax

{
    'SiteId': 'string',
    'AddressType': 'SHIPPING_ADDRESS'|'OPERATING_ADDRESS',
    'Address': {
        'ContactName': 'string',
        'ContactPhoneNumber': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'StateOrRegion': 'string',
        'DistrictOrCounty': 'string',
        'PostalCode': 'string',
        'CountryCode': 'string',
        'Municipality': 'string'
    }
}

Response Structure

(dict) --
- SiteId (string) --
  
  The ID of the site.
- AddressType (string) --
  
  The type of the address you receive.
- Address (dict) --
  
  Information about the address.
  - ContactName (string) --
    
    The name of the contact.
  - ContactPhoneNumber (string) --
    
    The phone number of the contact.
  - AddressLine1 (string) --
    
    The first line of the address.
  - AddressLine2 (string) --
    
    The second line of the address.
  - AddressLine3 (string) --
    
    The third line of the address.
  - City (string) --
    
    The city for the address.
  - StateOrRegion (string) --
    
    The state for the address.
  - DistrictOrCounty (string) --
    
    The district or county for the address.
  - PostalCode (string) --
    
    The postal code for the address.
  - CountryCode (string) --
    
    The ISO-3166 two-letter country code for the address.
  - Municipality (string) --
    
    The municipality for the address.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_assets(**kwargs)¶

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

response = client.list_assets(
    OutpostIdentifier='string',
    HostIdFilter=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    StatusFilter=[
        'ACTIVE'|'RETIRING',
    ]
)

Parameters

OutpostIdentifier (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.
HostIdFilter (list) --
Filters the results by the host ID of a Dedicated Host.
- (string) --
MaxResults (integer) -- The maximum page size.
NextToken (string) -- The pagination token.
StatusFilter (list) --
Filters the results by state.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Assets': [
        {
            'AssetId': 'string',
            'RackId': 'string',
            'AssetType': 'COMPUTE',
            'ComputeAttributes': {
                'HostId': 'string',
                'State': 'ACTIVE'|'ISOLATED'|'RETIRING'
            },
            'AssetLocation': {
                'RackElevation': ...
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Assets (list) --
  
  Information about the hardware assets.
  - (dict) --
    
    Information about hardware assets.
    - AssetId (string) --
      
      The ID of the asset.
    - RackId (string) --
      
      The rack ID of the asset.
    - AssetType (string) --
      
      The type of the asset.
    - ComputeAttributes (dict) --
      
      Information about compute hardware assets.
      - HostId (string) --
        
        The host ID of the Dedicated Host on the asset.
      - State (string) --
        
        The state.
        
        ACTIVE - The asset is available and can provide capacity for new compute resources.
        
        ISOLATED - The asset is undergoing maintenance and can't provide capacity for new compute resources. Existing compute resources on the asset are not affected.
        
        RETIRING - The underlying hardware for the asset is degraded. Capacity for new compute resources is reduced. Amazon Web Services sends notifications for resources that must be stopped before the asset can be replaced.
    - AssetLocation (dict) --
      
      The position of an asset in a rack.
      - RackElevation (float) --
        
        The position of an asset in a rack measured in rack units.
- NextToken (string) --
  
  The pagination token.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

list_catalog_items(**kwargs)¶

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

response = client.list_catalog_items(
    NextToken='string',
    MaxResults=123,
    ItemClassFilter=[
        'RACK'|'SERVER',
    ],
    SupportedStorageFilter=[
        'EBS'|'S3',
    ],
    EC2FamilyFilter=[
        'string',
    ]
)

Parameters

NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.
ItemClassFilter (list) --
Filters the results by item class.
- (string) --
SupportedStorageFilter (list) --
Filters the results by storage option.
- (string) --
EC2FamilyFilter (list) --
Filters the results by EC2 family (for example, M5).
- (string) --

Return type

dict

Returns

Response Syntax

{
    'CatalogItems': [
        {
            'CatalogItemId': 'string',
            'ItemStatus': 'AVAILABLE'|'DISCONTINUED',
            'EC2Capacities': [
                {
                    'Family': 'string',
                    'MaxSize': 'string',
                    'Quantity': 'string'
                },
            ],
            'PowerKva': ...,
            'WeightLbs': 123,
            'SupportedUplinkGbps': [
                123,
            ],
            'SupportedStorage': [
                'EBS'|'S3',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CatalogItems (list) --
  
  Information about the catalog items.
  - (dict) --
    
    Information about a catalog item.
    - CatalogItemId (string) --
      
      The ID of the catalog item.
    - ItemStatus (string) --
      
      The status of a catalog item.
    - EC2Capacities (list) --
      
      Information about the EC2 capacity of an item.
      - (dict) --
        
        Information about EC2 capacity.
        
        Family (string) --
        
        The family of the EC2 capacity.
        
        MaxSize (string) --
        
        The maximum size of the EC2 capacity.
        
        Quantity (string) --
        
        The quantity of the EC2 capacity.
    - PowerKva (float) --
      
      Information about the power draw of an item.
    - WeightLbs (integer) --
      
      The weight of the item in pounds.
    - SupportedUplinkGbps (list) --
      
      The uplink speed this catalog item requires for the connection to the Region.
      - (integer) --
    - SupportedStorage (list) --
      
      The supported storage options for the catalog item.
      - (string) --
- NextToken (string) --
  
  The pagination token.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

list_orders(**kwargs)¶

Lists the Outpost orders for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_orders(
    OutpostIdentifierFilter='string',
    NextToken='string',
    MaxResults=123
)

Parameters

OutpostIdentifierFilter (string) -- The ID or the Amazon Resource Name (ARN) of the Outpost.
NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.

Return type

dict

Returns

Response Syntax

{
    'Orders': [
        {
            'OutpostId': 'string',
            'OrderId': 'string',
            'OrderType': 'OUTPOST'|'REPLACEMENT',
            'Status': 'RECEIVED'|'PENDING'|'PROCESSING'|'INSTALLING'|'FULFILLED'|'CANCELLED'|'PREPARING'|'IN_PROGRESS'|'COMPLETED'|'ERROR',
            'LineItemCountsByStatus': {
                'string': 123
            },
            'OrderSubmissionDate': datetime(2015, 1, 1),
            'OrderFulfilledDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Orders (list) --
  
  Information about the orders.
  - (dict) --
    
    A summary of line items in your order.
    - OutpostId (string) --
      
      The ID of the Outpost.
    - OrderId (string) --
      
      The ID of the order.
    - OrderType (string) --
      
      The type of order.
    - Status (string) --
      
      The status of the order.
      - PREPARING - Order is received and is being prepared.
      - IN_PROGRESS - Order is either being built, shipped, or installed. For more information, see the LineItem status.
      - COMPLETED - Order is complete.
      - CANCELLED - Order is cancelled.
      - ERROR - Customer should contact support.
      Note
      
      The following statuses are deprecated: RECEIVED , PENDING , PROCESSING , INSTALLING , and FULFILLED .
    - LineItemCountsByStatus (dict) --
      
      The status of all line items in the order.
      - (string) --
        
        (integer) --
    - OrderSubmissionDate (datetime) --
      
      The submission date for the order.
    - OrderFulfilledDate (datetime) --
      
      The fulfilment date for the order.
- NextToken (string) --
  
  The pagination token.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

list_outposts(**kwargs)¶

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

response = client.list_outposts(
    NextToken='string',
    MaxResults=123,
    LifeCycleStatusFilter=[
        'string',
    ],
    AvailabilityZoneFilter=[
        'string',
    ],
    AvailabilityZoneIdFilter=[
        'string',
    ]
)

Parameters

NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.
LifeCycleStatusFilter (list) --
Filters the results by the lifecycle status.
- (string) --
  The life cycle status.
AvailabilityZoneFilter (list) --
Filters the results by Availability Zone (for example, us-east-1a ).
- (string) --
  The Availability Zone.
AvailabilityZoneIdFilter (list) --
Filters the results by AZ ID (for example, use1-az1 ).
- (string) --
  The ID of the Availability Zone.

Return type

dict

Returns

Response Syntax

{
    'Outposts': [
        {
            'OutpostId': 'string',
            'OwnerId': 'string',
            'OutpostArn': 'string',
            'SiteId': 'string',
            'Name': 'string',
            'Description': 'string',
            'LifeCycleStatus': 'string',
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'Tags': {
                'string': 'string'
            },
            'SiteArn': 'string',
            'SupportedHardwareType': 'RACK'|'SERVER'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Outposts (list) --
  
  Information about the Outposts.
  - (dict) --
    
    Information about an Outpost.
    - OutpostId (string) --
      
      The ID of the Outpost.
    - OwnerId (string) --
      
      The Amazon Web Services account ID of the Outpost owner.
    - OutpostArn (string) --
      
      The Amazon Resource Name (ARN) of the Outpost.
    - SiteId (string) --
      
      The ID of the site.
    - Name (string) --
      
      The name of the Outpost.
    - Description (string) --
      
      The description of the Outpost.
    - LifeCycleStatus (string) --
      
      The life cycle status.
    - AvailabilityZone (string) --
      
      The Availability Zone.
    - AvailabilityZoneId (string) --
      
      The ID of the Availability Zone.
    - Tags (dict) --
      
      The Outpost tags.
      - (string) --
        
        (string) --
    - SiteArn (string) --
      
      The Amazon Resource Name (ARN) of the site.
    - SupportedHardwareType (string) --
      
      The hardware type.
- NextToken (string) --
  
  The pagination token.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

list_sites(**kwargs)¶

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

See also: AWS API Documentation

Request Syntax

response = client.list_sites(
    NextToken='string',
    MaxResults=123,
    OperatingAddressCountryCodeFilter=[
        'string',
    ],
    OperatingAddressStateOrRegionFilter=[
        'string',
    ],
    OperatingAddressCityFilter=[
        'string',
    ]
)

Parameters

NextToken (string) -- The pagination token.
MaxResults (integer) -- The maximum page size.
OperatingAddressCountryCodeFilter (list) --
Filters the results by country code.
- (string) --
OperatingAddressStateOrRegionFilter (list) --
Filters the results by state or region.
- (string) --
OperatingAddressCityFilter (list) --
Filters the results by city.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Sites': [
        {
            'SiteId': 'string',
            'AccountId': 'string',
            'Name': 'string',
            'Description': 'string',
            'Tags': {
                'string': 'string'
            },
            'SiteArn': 'string',
            'Notes': 'string',
            'OperatingAddressCountryCode': 'string',
            'OperatingAddressStateOrRegion': 'string',
            'OperatingAddressCity': 'string',
            'RackPhysicalProperties': {
                'PowerDrawKva': 'POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
                'PowerPhase': 'SINGLE_PHASE'|'THREE_PHASE',
                'PowerConnector': 'L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
                'PowerFeedDrop': 'ABOVE_RACK'|'BELOW_RACK',
                'UplinkGbps': 'UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
                'UplinkCount': 'UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
                'FiberOpticCableType': 'SINGLE_MODE'|'MULTI_MODE',
                'OpticalStandard': 'OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
                'MaximumSupportedWeightLbs': 'NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Sites (list) --
  
  Information about the sites.
  - (dict) --
    
    Information about a site.
    - SiteId (string) --
      
      The ID of the site.
    - AccountId (string) --
      
      The ID of the Amazon Web Services account.
    - Name (string) --
      
      The name of the site.
    - Description (string) --
      
      The description of the site.
    - Tags (dict) --
      
      The site tags.
      - (string) --
        
        (string) --
    - SiteArn (string) --
      
      The Amazon Resource Name (ARN) of the site.
    - Notes (string) --
      
      Notes about a site.
    - OperatingAddressCountryCode (string) --
      
      The ISO-3166 two-letter country code where the hardware is installed and powered on.
    - OperatingAddressStateOrRegion (string) --
      
      State or region where the hardware is installed and powered on.
    - OperatingAddressCity (string) --
      
      City where the hardware is installed and powered on.
    - RackPhysicalProperties (dict) --
      
      Information about the physical and logistical details for a rack at the site.
      - PowerDrawKva (string) --
        
        The power draw available at the hardware placement position for the rack.
      - PowerPhase (string) --
        
        The power option that you can provide for hardware.
      - PowerConnector (string) --
        
        The power connector for the hardware.
      - PowerFeedDrop (string) --
        
        The position of the power feed.
      - UplinkGbps (string) --
        
        The uplink speed the rack supports for the connection to the Region.
      - UplinkCount (string) --
        
        The number of uplinks each Outpost network device.
      - FiberOpticCableType (string) --
        
        The type of fiber used to attach the Outpost to the network.
      - OpticalStandard (string) --
        
        The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
      - MaximumSupportedWeightLbs (string) --
        
        The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).
- NextToken (string) --
  
  The pagination token.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

list_tags_for_resource(**kwargs)¶

Lists the tags for the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Tags (dict) --
  The resource tags.
  - (string) --
    - (string) --

Exceptions

Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException

start_connection(**kwargs)¶

Note

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide .

See also: AWS API Documentation

Request Syntax

response = client.start_connection(
    DeviceSerialNumber='string',
    AssetId='string',
    ClientPublicKey='string',
    NetworkInterfaceDeviceIndex=123
)

Parameters

DeviceSerialNumber (string) --
[REQUIRED]

The serial number of the dongle.
AssetId (string) --
[REQUIRED]

The ID of the Outpost server.
ClientPublicKey (string) --
[REQUIRED]

The public key of the client.
NetworkInterfaceDeviceIndex (integer) --
[REQUIRED]

The device index of the network interface on the Outpost server.

Return type

dict

Returns

Response Syntax

{
    'ConnectionId': 'string',
    'UnderlayIpAddress': 'string'
}

Response Structure

(dict) --
- ConnectionId (string) --
  
  The ID of the connection.
- UnderlayIpAddress (string) --
  
  The underlay IP address.

Exceptions

Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.InternalServerException

tag_resource(**kwargs)¶

Adds tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters

ResourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
Tags (dict) --
[REQUIRED]

The tags to add to the resource.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException

untag_resource(**kwargs)¶

Removes tags from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
TagKeys (list) --
[REQUIRED]

The tag keys.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Outposts.Client.exceptions.InternalServerException
Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.NotFoundException

update_outpost(**kwargs)¶

Updates an Outpost.

See also: AWS API Documentation

Request Syntax

response = client.update_outpost(
    OutpostId='string',
    Name='string',
    Description='string',
    SupportedHardwareType='RACK'|'SERVER'
)

Parameters

OutpostId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the Outpost.
Name (string) -- The name of the Outpost.
Description (string) -- The description of the Outpost.
SupportedHardwareType (string) -- The type of hardware for this Outpost.

Return type

dict

Returns

Response Syntax

{
    'Outpost': {
        'OutpostId': 'string',
        'OwnerId': 'string',
        'OutpostArn': 'string',
        'SiteId': 'string',
        'Name': 'string',
        'Description': 'string',
        'LifeCycleStatus': 'string',
        'AvailabilityZone': 'string',
        'AvailabilityZoneId': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'SupportedHardwareType': 'RACK'|'SERVER'
    }
}

Response Structure

(dict) --
- Outpost (dict) --
  
  Information about an Outpost.
  - OutpostId (string) --
    
    The ID of the Outpost.
  - OwnerId (string) --
    
    The Amazon Web Services account ID of the Outpost owner.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost.
  - SiteId (string) --
    
    The ID of the site.
  - Name (string) --
    
    The name of the Outpost.
  - Description (string) --
    
    The description of the Outpost.
  - LifeCycleStatus (string) --
    
    The life cycle status.
  - AvailabilityZone (string) --
    
    The Availability Zone.
  - AvailabilityZoneId (string) --
    
    The ID of the Availability Zone.
  - Tags (dict) --
    
    The Outpost tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - SupportedHardwareType (string) --
    
    The hardware type.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

update_site(**kwargs)¶

Updates the specified site.

See also: AWS API Documentation

Request Syntax

response = client.update_site(
    SiteId='string',
    Name='string',
    Description='string',
    Notes='string'
)

Parameters

SiteId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.
Name (string) -- The name of the site.
Description (string) -- The description of the site.
Notes (string) -- Notes about a site.

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'Notes': 'string',
        'OperatingAddressCountryCode': 'string',
        'OperatingAddressStateOrRegion': 'string',
        'OperatingAddressCity': 'string',
        'RackPhysicalProperties': {
            'PowerDrawKva': 'POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
            'PowerPhase': 'SINGLE_PHASE'|'THREE_PHASE',
            'PowerConnector': 'L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
            'PowerFeedDrop': 'ABOVE_RACK'|'BELOW_RACK',
            'UplinkGbps': 'UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
            'UplinkCount': 'UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
            'FiberOpticCableType': 'SINGLE_MODE'|'MULTI_MODE',
            'OpticalStandard': 'OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
            'MaximumSupportedWeightLbs': 'NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
        }
    }
}

Response Structure

(dict) --
- Site (dict) --
  
  Information about a site.
  - SiteId (string) --
    
    The ID of the site.
  - AccountId (string) --
    
    The ID of the Amazon Web Services account.
  - Name (string) --
    
    The name of the site.
  - Description (string) --
    
    The description of the site.
  - Tags (dict) --
    
    The site tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - Notes (string) --
    
    Notes about a site.
  - OperatingAddressCountryCode (string) --
    
    The ISO-3166 two-letter country code where the hardware is installed and powered on.
  - OperatingAddressStateOrRegion (string) --
    
    State or region where the hardware is installed and powered on.
  - OperatingAddressCity (string) --
    
    City where the hardware is installed and powered on.
  - RackPhysicalProperties (dict) --
    
    Information about the physical and logistical details for a rack at the site.
    - PowerDrawKva (string) --
      
      The power draw available at the hardware placement position for the rack.
    - PowerPhase (string) --
      
      The power option that you can provide for hardware.
    - PowerConnector (string) --
      
      The power connector for the hardware.
    - PowerFeedDrop (string) --
      
      The position of the power feed.
    - UplinkGbps (string) --
      
      The uplink speed the rack supports for the connection to the Region.
    - UplinkCount (string) --
      
      The number of uplinks each Outpost network device.
    - FiberOpticCableType (string) --
      
      The type of fiber used to attach the Outpost to the network.
    - OpticalStandard (string) --
      
      The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
    - MaximumSupportedWeightLbs (string) --
      
      The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

update_site_address(**kwargs)¶

Updates the address of the specified site.

You can't update a site address if there is an order in progress. You must wait for the order to complete or cancel the order.

You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.

See also: AWS API Documentation

Request Syntax

response = client.update_site_address(
    SiteId='string',
    AddressType='SHIPPING_ADDRESS'|'OPERATING_ADDRESS',
    Address={
        'ContactName': 'string',
        'ContactPhoneNumber': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'StateOrRegion': 'string',
        'DistrictOrCounty': 'string',
        'PostalCode': 'string',
        'CountryCode': 'string',
        'Municipality': 'string'
    }
)

Parameters

SiteId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.
AddressType (string) --
[REQUIRED]

The type of the address.
Address (dict) --
[REQUIRED]

The address for the site.
- ContactName (string) --
  The name of the contact.
- ContactPhoneNumber (string) --
  The phone number of the contact.
- AddressLine1 (string) -- [REQUIRED]
  The first line of the address.
- AddressLine2 (string) --
  The second line of the address.
- AddressLine3 (string) --
  The third line of the address.
- City (string) -- [REQUIRED]
  The city for the address.
- StateOrRegion (string) -- [REQUIRED]
  The state for the address.
- DistrictOrCounty (string) --
  The district or county for the address.
- PostalCode (string) -- [REQUIRED]
  The postal code for the address.
- CountryCode (string) -- [REQUIRED]
  The ISO-3166 two-letter country code for the address.
- Municipality (string) --
  The municipality for the address.

Return type

dict

Returns

Response Syntax

{
    'AddressType': 'SHIPPING_ADDRESS'|'OPERATING_ADDRESS',
    'Address': {
        'ContactName': 'string',
        'ContactPhoneNumber': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'StateOrRegion': 'string',
        'DistrictOrCounty': 'string',
        'PostalCode': 'string',
        'CountryCode': 'string',
        'Municipality': 'string'
    }
}

Response Structure

(dict) --
- AddressType (string) --
  
  The type of the address.
- Address (dict) --
  
  Information about an address.
  - ContactName (string) --
    
    The name of the contact.
  - ContactPhoneNumber (string) --
    
    The phone number of the contact.
  - AddressLine1 (string) --
    
    The first line of the address.
  - AddressLine2 (string) --
    
    The second line of the address.
  - AddressLine3 (string) --
    
    The third line of the address.
  - City (string) --
    
    The city for the address.
  - StateOrRegion (string) --
    
    The state for the address.
  - DistrictOrCounty (string) --
    
    The district or county for the address.
  - PostalCode (string) --
    
    The postal code for the address.
  - CountryCode (string) --
    
    The ISO-3166 two-letter country code for the address.
  - Municipality (string) --
    
    The municipality for the address.

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.InternalServerException

update_site_rack_physical_properties(**kwargs)¶

Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist in the Amazon Web Services Outposts User Guide.

To update a rack at a site with an order of IN_PROGRESS , you must wait for the order to complete or cancel the order.

See also: AWS API Documentation

Request Syntax

response = client.update_site_rack_physical_properties(
    SiteId='string',
    PowerDrawKva='POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
    PowerPhase='SINGLE_PHASE'|'THREE_PHASE',
    PowerConnector='L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
    PowerFeedDrop='ABOVE_RACK'|'BELOW_RACK',
    UplinkGbps='UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
    UplinkCount='UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
    FiberOpticCableType='SINGLE_MODE'|'MULTI_MODE',
    OpticalStandard='OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
    MaximumSupportedWeightLbs='NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
)

Parameters

SiteId (string) --
[REQUIRED]

The ID or the Amazon Resource Name (ARN) of the site.
PowerDrawKva (string) -- The power draw, in kVA, available at the hardware placement position for the rack.
PowerPhase (string) --
The power option that you can provide for hardware.
- Single-phase AC feed: 200 V to 277 V, 50 Hz or 60 Hz
- Three-phase AC feed: 346 V to 480 V, 50 Hz or 60 Hz
PowerConnector (string) --
The power connector that Amazon Web Services should plan to provide for connections to the hardware. Note the correlation between PowerPhase and PowerConnector .
- Single-phase AC feed
  - L6-30P – (common in US); 30A; single phase
  - IEC309 (blue) – P+N+E, 6hr; 32 A; single phase
- Three-phase AC feed
  - AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase
  - AH532P6W (red) – 3P+N+E, 6hr; 32A; three phase
PowerFeedDrop (string) -- Indicates whether the power feed comes above or below the rack.
UplinkGbps (string) -- The uplink speed the rack should support for the connection to the Region.
UplinkCount (string) --
Racks come with two Outpost network devices. Depending on the supported uplink speed at the site, the Outpost network devices provide a variable number of uplinks. Specify the number of uplinks for each Outpost network device that you intend to use to connect the rack to your network. Note the correlation between UplinkGbps and UplinkCount .
- 1Gbps - Uplinks available: 1, 2, 4, 6, 8
- 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16
- 40 and 100 Gbps- Uplinks available: 1, 2, 4
FiberOpticCableType (string) -- The type of fiber that you will use to attach the Outpost to your network.
OpticalStandard (string) --
The type of optical standard that you will use to attach the Outpost to your network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
- OPTIC_10GBASE_SR : 10GBASE-SR
- OPTIC_10GBASE_IR : 10GBASE-IR
- OPTIC_10GBASE_LR : 10GBASE-LR
- OPTIC_40GBASE_SR : 40GBASE-SR
- OPTIC_40GBASE_ESR : 40GBASE-ESR
- OPTIC_40GBASE_IR4_LR4L : 40GBASE-IR (LR4L)
- OPTIC_40GBASE_LR4 : 40GBASE-LR4
- OPTIC_100GBASE_SR4 : 100GBASE-SR4
- OPTIC_100GBASE_CWDM4 : 100GBASE-CWDM4
- OPTIC_100GBASE_LR4 : 100GBASE-LR4
- OPTIC_100G_PSM4_MSA : 100G PSM4 MSA
- OPTIC_1000BASE_LX : 1000Base-LX
- OPTIC_1000BASE_SX : 1000Base-SX
MaximumSupportedWeightLbs (string) -- The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.

Return type

dict

Returns

Response Syntax

{
    'Site': {
        'SiteId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        },
        'SiteArn': 'string',
        'Notes': 'string',
        'OperatingAddressCountryCode': 'string',
        'OperatingAddressStateOrRegion': 'string',
        'OperatingAddressCity': 'string',
        'RackPhysicalProperties': {
            'PowerDrawKva': 'POWER_5_KVA'|'POWER_10_KVA'|'POWER_15_KVA'|'POWER_30_KVA',
            'PowerPhase': 'SINGLE_PHASE'|'THREE_PHASE',
            'PowerConnector': 'L6_30P'|'IEC309'|'AH530P7W'|'AH532P6W',
            'PowerFeedDrop': 'ABOVE_RACK'|'BELOW_RACK',
            'UplinkGbps': 'UPLINK_1G'|'UPLINK_10G'|'UPLINK_40G'|'UPLINK_100G',
            'UplinkCount': 'UPLINK_COUNT_1'|'UPLINK_COUNT_2'|'UPLINK_COUNT_3'|'UPLINK_COUNT_4'|'UPLINK_COUNT_5'|'UPLINK_COUNT_6'|'UPLINK_COUNT_7'|'UPLINK_COUNT_8'|'UPLINK_COUNT_12'|'UPLINK_COUNT_16',
            'FiberOpticCableType': 'SINGLE_MODE'|'MULTI_MODE',
            'OpticalStandard': 'OPTIC_10GBASE_SR'|'OPTIC_10GBASE_IR'|'OPTIC_10GBASE_LR'|'OPTIC_40GBASE_SR'|'OPTIC_40GBASE_ESR'|'OPTIC_40GBASE_IR4_LR4L'|'OPTIC_40GBASE_LR4'|'OPTIC_100GBASE_SR4'|'OPTIC_100GBASE_CWDM4'|'OPTIC_100GBASE_LR4'|'OPTIC_100G_PSM4_MSA'|'OPTIC_1000BASE_LX'|'OPTIC_1000BASE_SX',
            'MaximumSupportedWeightLbs': 'NO_LIMIT'|'MAX_1400_LBS'|'MAX_1600_LBS'|'MAX_1800_LBS'|'MAX_2000_LBS'
        }
    }
}

Response Structure

(dict) --
- Site (dict) --
  
  Information about a site.
  - SiteId (string) --
    
    The ID of the site.
  - AccountId (string) --
    
    The ID of the Amazon Web Services account.
  - Name (string) --
    
    The name of the site.
  - Description (string) --
    
    The description of the site.
  - Tags (dict) --
    
    The site tags.
    - (string) --
      - (string) --
  - SiteArn (string) --
    
    The Amazon Resource Name (ARN) of the site.
  - Notes (string) --
    
    Notes about a site.
  - OperatingAddressCountryCode (string) --
    
    The ISO-3166 two-letter country code where the hardware is installed and powered on.
  - OperatingAddressStateOrRegion (string) --
    
    State or region where the hardware is installed and powered on.
  - OperatingAddressCity (string) --
    
    City where the hardware is installed and powered on.
  - RackPhysicalProperties (dict) --
    
    Information about the physical and logistical details for a rack at the site.
    - PowerDrawKva (string) --
      
      The power draw available at the hardware placement position for the rack.
    - PowerPhase (string) --
      
      The power option that you can provide for hardware.
    - PowerConnector (string) --
      
      The power connector for the hardware.
    - PowerFeedDrop (string) --
      
      The position of the power feed.
    - UplinkGbps (string) --
      
      The uplink speed the rack supports for the connection to the Region.
    - UplinkCount (string) --
      
      The number of uplinks each Outpost network device.
    - FiberOpticCableType (string) --
      
      The type of fiber used to attach the Outpost to the network.
    - OpticalStandard (string) --
      
      The type of optical standard used to attach the Outpost to the network. This field is dependent on uplink speed, fiber type, and distance to the upstream device. For more information about networking requirements for racks, see Network in the Amazon Web Services Outposts User Guide.
    - MaximumSupportedWeightLbs (string) --
      
      The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

Exceptions

Outposts.Client.exceptions.ValidationException
Outposts.Client.exceptions.ConflictException
Outposts.Client.exceptions.NotFoundException
Outposts.Client.exceptions.AccessDeniedException
Outposts.Client.exceptions.InternalServerException

Paginators ¶

The available paginators are:

Table Of Contents

Outposts¶

Client¶

Paginators¶

Outposts ¶

Client ¶

Paginators ¶