The AWS Outposts API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Address (p. 68)
• CatalogItem (p. 71)
• EC2Capacity (p. 73)
• InstanceTypeItem (p. 74)
• LineItem (p. 75)
• LineItemRequest (p. 76)
• Order (p. 77)
• OrderSummary (p. 79)
• Outpost (p. 81)
• RackPhysicalProperties (p. 84)
• Site (p. 86)
Address
Address
Information about an address.
Contents
AddressLine1
The first line of the address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^\S[\S ]*$
Required: Yes AddressLine2
The second line of the address.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 60.
Pattern: ^\S[\S ]*$
Required: No AddressLine3
The third line of the address.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 60.
Pattern: ^\S[\S ]*$
Required: No City
The city for the address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: ^\S[\S ]*$
Required: Yes ContactName
The name of the contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^\S[\S ]*$
Contents
Required: No ContactPhoneNumber
The phone number of the contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: ^[\S ]+$
Required: No CountryCode
The ISO-3166 two-letter country code for the address.
Type: String
Length Constraints: Fixed length of 2.
Pattern: ^[A-Z]{2}$
Required: Yes DistrictOrCounty
The district or county for the address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Pattern: ^\S[\S ]*
Required: No Municipality
The municipality for the address.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 180.
Pattern: ^\S[\S ]*$
Required: No PostalCode
See Also
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: ^\S[\S ]*$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CatalogItem
CatalogItem
Information about a catalog item.
Contents
CatalogItemId
The ID of the catalog item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: OR-[A-Z0-9]{7}
Required: No EC2Capacities
Information about the EC2 capacity of an item.
Type: Array of EC2Capacity (p. 73) objects Required: No
ItemStatus
The status of a catalog item.
Type: String
Valid Values: AVAILABLE | DISCONTINUED Required: No
PowerKva
Information about the power draw of an item.
Type: Float Required: No SupportedStorage
The supported storage options for the catalog item.
Type: Array of strings
See Also
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
EC2Capacity
EC2Capacity
Information about EC2 capacity.
Contents
Family
The family of the EC2 capacity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: [a-z0-9]+
Required: No MaxSize
The maximum size of the EC2 capacity.
Type: String Required: No Quantity
The quantity of the EC2 capacity.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InstanceTypeItem
InstanceTypeItem
Information about an instance type.
Contents
InstanceType
The instance type.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
LineItem
LineItem
Information about a line item.
Contents
CatalogItemId
The ID of the catalog item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: OR-[A-Z0-9]{7}
Required: No LineItemId
The ID of the line item.
Type: String
Pattern: ooi-[a-f0-9]{17}
Required: No Quantity
The quantity of the line item.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No Status
The status of the line item.
Type: String
Valid Values: PREPARING | BUILDING | SHIPPED | DELIVERED | INSTALLING | INSTALLED | ERROR | CANCELLED
LineItemRequest
LineItemRequest
Information about a line item request.
Contents
CatalogItemId
The ID of the catalog item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern: OR-[A-Z0-9]{7}
Required: No Quantity
The quantity of a line item request.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Order
Order
Information about an order.
Contents
LineItems
The line items for the order
Type: Array of LineItem (p. 75) objects Required: No
OrderFulfilledDate
The fulfillment date of the order.
Type: Timestamp Required: No OrderId
The ID of the order.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: oo-[a-f0-9]{17}$
Required: No OrderSubmissionDate
The submission date for the order.
Type: Timestamp Required: No OutpostId
The ID of the Outpost in the order.
Type: String
See Also
Status
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 LineItem status.
• COMPLETED - Order is complete.
• CANCELLED - Order is cancelled.
• ERROR - Customer should contact support.
NoteThe following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
Type: String
Valid Values: RECEIVED | PENDING | PROCESSING | INSTALLING | FULFILLED | CANCELLED | PREPARING | IN_PROGRESS | COMPLETED | ERROR
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OrderSummary
OrderSummary
A summary of line items in your order.
Contents
LineItemCountsByStatus
The status of all line items in the order.
Type: String to integer map
Valid Keys: PREPARING | BUILDING | SHIPPED | DELIVERED | INSTALLING | INSTALLED
| ERROR | CANCELLED
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No OrderFulfilledDate
Fulfilment date for the order.
Type: Timestamp Required: No OrderId
The ID of the order.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: oo-[a-f0-9]{17}$
Required: No OrderSubmissionDate
Submission date for the order.
Type: Timestamp Required: No OrderType
See Also
Pattern: ^op-[a-f0-9]{17}$
Required: No Status
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.
NoteThe following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.
Type: String
Valid Values: RECEIVED | PENDING | PROCESSING | INSTALLING | FULFILLED | CANCELLED | PREPARING | IN_PROGRESS | COMPLETED | ERROR
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Outpost
Outpost
Information about an Outpost.
Contents
AvailabilityZone
The Availability Zone.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\d+[a-zA-Z]?)?$
Required: No AvailabilityZoneId
The ID of the Availability Zone.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^[a-zA-Z]+\d-[a-zA-Z]+\d$
Required: No Description
The description of the Outpost.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern: ^[\S ]*$
Required: No LifeCycleStatus
The life cycle status.
Type: String
Contents
Required: No OutpostArn
The Amazon Resource Name (ARN) of the Outpost.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$
Required: No OutpostId
The ID of the Outpost.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 180.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]
{17}$
Required: No OwnerId
The AWS account ID of the Outpost owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern: \d{12}
Required: No SiteArn
The Amazon Resource Name (ARN) of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$
Required: No SiteId
The ID of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/)?(os-[a-f0-9]
{17})$
Required: No
SupportedHardwareType The hardware type.
See Also
Type: String
Valid Values: RACK | SERVER Required: No
Tags
The Outpost tags.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Value Pattern: ^[\S \n]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RackPhysicalProperties
RackPhysicalProperties
Information about the physical and logistical details for racks at sites. For more information about hardware requirements for racks, see Network readiness checklist in the AWS Outposts User Guide.
Contents
FiberOpticCableType
The type of fiber used to attach the Outpost to the network.
Type: String
Valid Values: SINGLE_MODE | MULTI_MODE Required: No
MaximumSupportedWeightLbs
The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).
Type: String
Valid Values: NO_LIMIT | MAX_1400_LBS | MAX_1600_LBS | MAX_1800_LBS | MAX_2000_LBS
Required: No OpticalStandard
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 AWS Outposts User Guide.
Type: String
Valid Values: 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
Required: No PowerConnector
The power connector for the hardware.
Type: String
Valid Values: L6_30P | IEC309 | AH530P7W | AH532P6W Required: No
PowerDrawKva
The power draw available at the hardware placement position for the rack.
Type: String
Valid Values: POWER_5_KVA | POWER_10_KVA | POWER_15_KVA
See Also
Required: No PowerFeedDrop
The position of the power feed.
Type: String
Valid Values: ABOVE_RACK | BELOW_RACK Required: No
PowerPhase
The power option that you can provide for hardware.
Type: String
Valid Values: SINGLE_PHASE | THREE_PHASE Required: No
UplinkCount
The number of uplinks each Outpost network device.
Type: String
Valid Values: 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
Required: No UplinkGbps
The uplink speed the rack supports for the connection to the Region.
Type: String
Valid Values: UPLINK_1G | UPLINK_10G | UPLINK_40G | UPLINK_100G Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
Site
Site
Information about a site.
Contents
AccountId
The ID of the AWS account.
Type: String
Length Constraints: Fixed length of 12.
Pattern: \d{12}
Required: No Description
The description of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1001.
Pattern: ^[\S ]+$
Required: No Name
The name of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: ^[\S ]+$
Required: No Notes
Notes about a site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Pattern: ^[\S \n]+$
Required: No OperatingAddressCity
City where the hardware is installed and powered on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: ^\S[\S ]*$
Contents
Required: No
OperatingAddressCountryCode
The ISO-3166 two-letter country code where the hardware is installed and powered on.
Type: String
Length Constraints: Fixed length of 2.
Pattern: ^[A-Z]{2}$
Required: No
OperatingAddressStateOrRegion
State or region where the hardware is installed and powered on.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: ^\S[\S ]*$
Required: No RackPhysicalProperties
Information about the physical and logistical details for a rack at the site.
Type: RackPhysicalProperties (p. 84) object Required: No
SiteArn
The Amazon Resource Name (ARN) of the site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:site/(os-[a-f0-9]{17})$
Required: No SiteId
The ID of the site.
Type: String
See Also
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Value Pattern: ^[\S \n]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3