2022/03/11 - AWS Outposts - 1 updated api methods
Changes This release adds address filters for listSites
{'OperatingAddressCityFilter': ['string'], 'OperatingAddressCountryCodeFilter': ['string'], 'OperatingAddressStateOrRegionFilter': ['string']}
Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address.
If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.
See also: AWS API Documentation
Request Syntax
client.list_sites( NextToken='string', MaxResults=123, OperatingAddressCountryCodeFilter=[ 'string', ], OperatingAddressStateOrRegionFilter=[ 'string', ], OperatingAddressCityFilter=[ 'string', ] )
string
The pagination token.
integer
The maximum page size.
list
A filter for the country code of the Outpost site.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
list
A filter for the state/region of the Outpost site.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
list
A filter for the city of the Outpost site.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
(string) --
dict
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', '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.