SDK for PHP 3.x

Client: Aws\Outposts\OutpostsClient
Service ID: outposts
Version: 2019-12-03

This page describes the parameters and results for the operations of the AWS Outposts (2019-12-03), and shows how to use the Aws\Outposts\OutpostsClient object to call the described operations. This documentation is specific to the 2019-12-03 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelCapacityTask ( array $params = [] )
Cancels the capacity task.
CancelOrder ( array $params = [] )
Cancels the specified order for an Outpost.
CreateOrder ( array $params = [] )
Creates an order for an Outpost.
CreateOutpost ( array $params = [] )
Creates an Outpost.
CreateSite ( array $params = [] )
Creates a site for an Outpost.
DeleteOutpost ( array $params = [] )
Deletes the specified Outpost.
DeleteSite ( array $params = [] )
Deletes the specified site.
GetCapacityTask ( array $params = [] )
Gets details of the specified capacity task.
GetCatalogItem ( array $params = [] )
Gets information about the specified catalog item.
GetConnection ( array $params = [] )
Amazon Web Services uses this action to install Outpost servers.
GetOrder ( array $params = [] )
Gets information about the specified order.
GetOutpost ( array $params = [] )
Gets information about the specified Outpost.
GetOutpostInstanceTypes ( array $params = [] )
Gets the instance types for the specified Outpost.
GetOutpostSupportedInstanceTypes ( array $params = [] )
Gets the instance types that an Outpost can support in InstanceTypeCapacity.
GetSite ( array $params = [] )
Gets information about the specified Outpost site.
GetSiteAddress ( array $params = [] )
Gets the site address of the specified site.
ListAssets ( array $params = [] )
Lists the hardware assets for the specified Outpost.
ListCapacityTasks ( array $params = [] )
Lists the capacity tasks for your Amazon Web Services account.
ListCatalogItems ( array $params = [] )
Lists the items in the catalog.
ListOrders ( array $params = [] )
Lists the Outpost orders for your Amazon Web Services account.
ListOutposts ( array $params = [] )
Lists the Outposts for your Amazon Web Services account.
ListSites ( array $params = [] )
Lists the Outpost sites for your Amazon Web Services account.
ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
StartCapacityTask ( array $params = [] )
Starts the specified capacity task.
StartConnection ( array $params = [] )
Amazon Web Services uses this action to install Outpost servers.
TagResource ( array $params = [] )
Adds tags to the specified resource.
UntagResource ( array $params = [] )
Removes tags from the specified resource.
UpdateOutpost ( array $params = [] )
Updates an Outpost.
UpdateSite ( array $params = [] )
Updates the specified site.
UpdateSiteAddress ( array $params = [] )
Updates the address of the specified site.
UpdateSiteRackPhysicalProperties ( array $params = [] )
Update the physical and logistical details for a rack at a site.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetOutpostInstanceTypes
GetOutpostSupportedInstanceTypes
ListAssets
ListCapacityTasks
ListCatalogItems
ListOrders
ListOutposts
ListSites

Operations

CancelCapacityTask

$result = $client->cancelCapacityTask([/* ... */]);
$promise = $client->cancelCapacityTaskAsync([/* ... */]);

Cancels the capacity task.

Parameter Syntax

$result = $client->cancelCapacityTask([
    'CapacityTaskId' => '<string>', // REQUIRED
    'OutpostIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
CapacityTaskId
Required: Yes
Type: string

ID of the capacity task that you want to cancel.

OutpostIdentifier
Required: Yes
Type: string

ID or ARN of the Outpost associated with the capacity task that you want to cancel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

An internal error has occurred.

CancelOrder

$result = $client->cancelOrder([/* ... */]);
$promise = $client->cancelOrderAsync([/* ... */]);

Cancels the specified order for an Outpost.

Parameter Syntax

$result = $client->cancelOrder([
    'OrderId' => '<string>', // REQUIRED
]);

Parameter Details

Members
OrderId
Required: Yes
Type: string

The ID of the order.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

CreateOrder

$result = $client->createOrder([/* ... */]);
$promise = $client->createOrderAsync([/* ... */]);

Creates an order for an Outpost.

Parameter Syntax

$result = $client->createOrder([
    'LineItems' => [ // REQUIRED
        [
            'CatalogItemId' => '<string>',
            'Quantity' => <integer>,
        ],
        // ...
    ],
    'OutpostIdentifier' => '<string>', // REQUIRED
    'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT', // REQUIRED
    'PaymentTerm' => 'THREE_YEARS|ONE_YEAR',
]);

Parameter Details

Members
LineItems
Required: Yes
Type: Array of LineItemRequest structures

The line items that make up the order.

OutpostIdentifier
Required: Yes
Type: string

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

PaymentOption
Required: Yes
Type: string

The payment option.

PaymentTerm
Type: string

The payment terms.

Result Syntax

[
    'Order' => [
        'LineItems' => [
            [
                'AssetInformationList' => [
                    [
                        'AssetId' => '<string>',
                        'MacAddressList' => ['<string>', ...],
                    ],
                    // ...
                ],
                'CatalogItemId' => '<string>',
                'LineItemId' => '<string>',
                'PreviousLineItemId' => '<string>',
                'PreviousOrderId' => '<string>',
                'Quantity' => <integer>,
                'ShipmentInformation' => [
                    'ShipmentCarrier' => 'DHL|DBS|FEDEX|UPS|EXPEDITORS',
                    'ShipmentTrackingNumber' => '<string>',
                ],
                'Status' => 'PREPARING|BUILDING|SHIPPED|DELIVERED|INSTALLING|INSTALLED|ERROR|CANCELLED|REPLACED',
            ],
            // ...
        ],
        'OrderFulfilledDate' => <DateTime>,
        'OrderId' => '<string>',
        'OrderSubmissionDate' => <DateTime>,
        'OrderType' => 'OUTPOST|REPLACEMENT',
        'OutpostId' => '<string>',
        'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
        'PaymentTerm' => 'THREE_YEARS|ONE_YEAR',
        'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|DELIVERED|COMPLETED|ERROR',
    ],
]

Result Details

Members
Order
Type: Order structure

Information about this order.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

ServiceQuotaExceededException:

You have exceeded a service quota.

CreateOutpost

$result = $client->createOutpost([/* ... */]);
$promise = $client->createOutpostAsync([/* ... */]);

Creates an Outpost.

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

Parameter Syntax

$result = $client->createOutpost([
    'AvailabilityZone' => '<string>',
    'AvailabilityZoneId' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
    'SupportedHardwareType' => 'RACK|SERVER',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
AvailabilityZone
Type: string

The Availability Zone.

AvailabilityZoneId
Type: string

The ID of the Availability Zone.

Description
Type: string

The description of the Outpost.

Name
Required: Yes
Type: string

The name of the Outpost.

SiteId
Required: Yes
Type: string

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

SupportedHardwareType
Type: string

The type of hardware for this Outpost.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to the Outpost.

Result Syntax

[
    'Outpost' => [
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneId' => '<string>',
        'Description' => '<string>',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'SupportedHardwareType' => 'RACK|SERVER',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Outpost
Type: Outpost structure

Information about an Outpost.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

ServiceQuotaExceededException:

You have exceeded a service quota.

CreateSite

$result = $client->createSite([/* ... */]);
$promise = $client->createSiteAsync([/* ... */]);

Creates a site for an Outpost.

Parameter Syntax

$result = $client->createSite([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Notes' => '<string>',
    'OperatingAddress' => [
        'AddressLine1' => '<string>', // REQUIRED
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>', // REQUIRED
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>', // REQUIRED
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>', // REQUIRED
        'StateOrRegion' => '<string>', // REQUIRED
    ],
    'RackPhysicalProperties' => [
        'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
        'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
        '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',
        'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
        'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
        'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
        'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
        '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',
        'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
    ],
    'ShippingAddress' => [
        'AddressLine1' => '<string>', // REQUIRED
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>', // REQUIRED
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>', // REQUIRED
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>', // REQUIRED
        'StateOrRegion' => '<string>', // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
Type: string

The description of the site.

Name
Required: Yes
Type: string

The name of the site.

Notes
Type: 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.

OperatingAddress
Type: Address structure

The location to install and power on the hardware. This address might be different from the shipping address.

RackPhysicalProperties
Type: RackPhysicalProperties structure

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.

ShippingAddress
Type: Address structure

The location to ship the hardware. This address might be different from the operating address.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to a site.

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            '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',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            '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',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
Type: Site structure

Information about a site.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

ServiceQuotaExceededException:

You have exceeded a service quota.

DeleteOutpost

$result = $client->deleteOutpost([/* ... */]);
$promise = $client->deleteOutpostAsync([/* ... */]);

Deletes the specified Outpost.

Parameter Syntax

$result = $client->deleteOutpost([
    'OutpostId' => '<string>', // REQUIRED
]);

Parameter Details

Members
OutpostId
Required: Yes
Type: string

The ID or ARN of the Outpost.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

DeleteSite

$result = $client->deleteSite([/* ... */]);
$promise = $client->deleteSiteAsync([/* ... */]);

Deletes the specified site.

Parameter Syntax

$result = $client->deleteSite([
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SiteId
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

GetCapacityTask

$result = $client->getCapacityTask([/* ... */]);
$promise = $client->getCapacityTaskAsync([/* ... */]);

Gets details of the specified capacity task.

Parameter Syntax

$result = $client->getCapacityTask([
    'CapacityTaskId' => '<string>', // REQUIRED
    'OutpostIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
CapacityTaskId
Required: Yes
Type: string

ID of the capacity task.

OutpostIdentifier
Required: Yes
Type: string

ID or ARN of the Outpost associated with the specified capacity task.

Result Syntax

[
    'CapacityTaskId' => '<string>',
    'CapacityTaskStatus' => 'REQUESTED|IN_PROGRESS|FAILED|COMPLETED|CANCELLED',
    'CompletionDate' => <DateTime>,
    'CreationDate' => <DateTime>,
    'DryRun' => true || false,
    'Failed' => [
        'Reason' => '<string>',
        'Type' => 'UNSUPPORTED_CAPACITY_CONFIGURATION',
    ],
    'LastModifiedDate' => <DateTime>,
    'OrderId' => '<string>',
    'OutpostId' => '<string>',
    'RequestedInstancePools' => [
        [
            'Count' => <integer>,
            'InstanceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
CapacityTaskId
Type: string

ID of the capacity task.

CapacityTaskStatus
Type: string

Status of the capacity task.

A capacity task can have one of the following statuses:

  • REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.

  • IN_PROGRESS - The capacity task is running and cannot be cancelled.

  • WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.

CompletionDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the capacity task ran successfully.

CreationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the capacity task was created.

DryRun
Type: boolean

Performs a dry run to determine if you are above or below instance capacity.

Failed
Type: CapacityTaskFailure structure

Reason why the capacity task failed.

LastModifiedDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date the capacity task was last modified.

OrderId
Type: string

ID of the Amazon Web Services Outposts order associated with the specified capacity task.

OutpostId
Type: string

ID of the Outpost associated with the specified capacity task.

RequestedInstancePools
Type: Array of InstanceTypeCapacity structures

List of instance pools requested in the capacity task.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

GetCatalogItem

$result = $client->getCatalogItem([/* ... */]);
$promise = $client->getCatalogItemAsync([/* ... */]);

Gets information about the specified catalog item.

Parameter Syntax

$result = $client->getCatalogItem([
    'CatalogItemId' => '<string>', // REQUIRED
]);

Parameter Details

Members
CatalogItemId
Required: Yes
Type: string

The ID of the catalog item.

Result Syntax

[
    'CatalogItem' => [
        'CatalogItemId' => '<string>',
        'EC2Capacities' => [
            [
                'Family' => '<string>',
                'MaxSize' => '<string>',
                'Quantity' => '<string>',
            ],
            // ...
        ],
        'ItemStatus' => 'AVAILABLE|DISCONTINUED',
        'PowerKva' => <float>,
        'SupportedStorage' => ['<string>', ...],
        'SupportedUplinkGbps' => [<integer>, ...],
        'WeightLbs' => <integer>,
    ],
]

Result Details

Members
CatalogItem
Type: CatalogItem structure

Information about this catalog item.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

GetConnection

$result = $client->getConnection([/* ... */]);
$promise = $client->getConnectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getConnection([
    'ConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConnectionId
Required: Yes
Type: string

The ID of the connection.

Result Syntax

[
    'ConnectionDetails' => [
        'AllowedIps' => ['<string>', ...],
        'ClientPublicKey' => '<string>',
        'ClientTunnelAddress' => '<string>',
        'ServerEndpoint' => '<string>',
        'ServerPublicKey' => '<string>',
        'ServerTunnelAddress' => '<string>',
    ],
    'ConnectionId' => '<string>',
]

Result Details

Members
ConnectionDetails
Type: ConnectionDetails structure

Information about the connection.

ConnectionId
Type: string

The ID of the connection.

Errors

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

GetOrder

$result = $client->getOrder([/* ... */]);
$promise = $client->getOrderAsync([/* ... */]);

Gets information about the specified order.

Parameter Syntax

$result = $client->getOrder([
    'OrderId' => '<string>', // REQUIRED
]);

Parameter Details

Members
OrderId
Required: Yes
Type: string

The ID of the order.

Result Syntax

[
    'Order' => [
        'LineItems' => [
            [
                'AssetInformationList' => [
                    [
                        'AssetId' => '<string>',
                        'MacAddressList' => ['<string>', ...],
                    ],
                    // ...
                ],
                'CatalogItemId' => '<string>',
                'LineItemId' => '<string>',
                'PreviousLineItemId' => '<string>',
                'PreviousOrderId' => '<string>',
                'Quantity' => <integer>,
                'ShipmentInformation' => [
                    'ShipmentCarrier' => 'DHL|DBS|FEDEX|UPS|EXPEDITORS',
                    'ShipmentTrackingNumber' => '<string>',
                ],
                'Status' => 'PREPARING|BUILDING|SHIPPED|DELIVERED|INSTALLING|INSTALLED|ERROR|CANCELLED|REPLACED',
            ],
            // ...
        ],
        'OrderFulfilledDate' => <DateTime>,
        'OrderId' => '<string>',
        'OrderSubmissionDate' => <DateTime>,
        'OrderType' => 'OUTPOST|REPLACEMENT',
        'OutpostId' => '<string>',
        'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
        'PaymentTerm' => 'THREE_YEARS|ONE_YEAR',
        'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|DELIVERED|COMPLETED|ERROR',
    ],
]

Result Details

Members
Order
Type: Order structure

Information about an order.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

GetOutpost

$result = $client->getOutpost([/* ... */]);
$promise = $client->getOutpostAsync([/* ... */]);

Gets information about the specified Outpost.

Parameter Syntax

$result = $client->getOutpost([
    'OutpostId' => '<string>', // REQUIRED
]);

Parameter Details

Members
OutpostId
Required: Yes
Type: string

The ID or ARN of the Outpost.

Result Syntax

[
    'Outpost' => [
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneId' => '<string>',
        'Description' => '<string>',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'SupportedHardwareType' => 'RACK|SERVER',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Outpost
Type: Outpost structure

Information about an Outpost.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

GetOutpostInstanceTypes

$result = $client->getOutpostInstanceTypes([/* ... */]);
$promise = $client->getOutpostInstanceTypesAsync([/* ... */]);

Gets the instance types for the specified Outpost.

Parameter Syntax

$result = $client->getOutpostInstanceTypes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OutpostId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

OutpostId
Required: Yes
Type: string

The ID or ARN of the Outpost.

Result Syntax

[
    'InstanceTypes' => [
        [
            'InstanceType' => '<string>',
            'VCPUs' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'OutpostArn' => '<string>',
    'OutpostId' => '<string>',
]

Result Details

Members
InstanceTypes
Type: Array of InstanceTypeItem structures

Information about the instance types.

NextToken
Type: string

The pagination token.

OutpostArn
Type: string

The Amazon Resource Name (ARN) of the Outpost.

OutpostId
Type: string

The ID of the Outpost.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

GetOutpostSupportedInstanceTypes

$result = $client->getOutpostSupportedInstanceTypes([/* ... */]);
$promise = $client->getOutpostSupportedInstanceTypesAsync([/* ... */]);

Gets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

Parameter Syntax

$result = $client->getOutpostSupportedInstanceTypes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OrderId' => '<string>', // REQUIRED
    'OutpostIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

OrderId
Required: Yes
Type: string

The ID for the Amazon Web Services Outposts order.

OutpostIdentifier
Required: Yes
Type: string

The ID or ARN of the Outpost.

Result Syntax

[
    'InstanceTypes' => [
        [
            'InstanceType' => '<string>',
            'VCPUs' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
InstanceTypes
Type: Array of InstanceTypeItem structures

Information about the instance types.

NextToken
Type: string

The pagination token.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

GetSite

$result = $client->getSite([/* ... */]);
$promise = $client->getSiteAsync([/* ... */]);

Gets information about the specified Outpost site.

Parameter Syntax

$result = $client->getSite([
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
SiteId
Required: Yes
Type: string

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

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            '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',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            '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',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
Type: Site structure

Information about a site.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

GetSiteAddress

$result = $client->getSiteAddress([/* ... */]);
$promise = $client->getSiteAddressAsync([/* ... */]);

Gets the site address of the specified site.

Parameter Syntax

$result = $client->getSiteAddress([
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AddressType
Required: Yes
Type: string

The type of the address you request.

SiteId
Required: Yes
Type: string

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

Result Syntax

[
    'Address' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>',
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>',
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>',
        'StateOrRegion' => '<string>',
    ],
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS',
    'SiteId' => '<string>',
]

Result Details

Members
Address
Type: Address structure

Information about the address.

AddressType
Type: string

The type of the address you receive.

SiteId
Type: string

The ID of the site.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

ListAssets

$result = $client->listAssets([/* ... */]);
$promise = $client->listAssetsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAssets([
    'HostIdFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OutpostIdentifier' => '<string>', // REQUIRED
    'StatusFilter' => ['<string>', ...],
]);

Parameter Details

Members
HostIdFilter
Type: Array of strings

Filters the results by the host ID of a Dedicated Host.

MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

OutpostIdentifier
Required: Yes
Type: string

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

StatusFilter
Type: Array of strings

Filters the results by state.

Result Syntax

[
    'Assets' => [
        [
            'AssetId' => '<string>',
            'AssetLocation' => [
                'RackElevation' => <float>,
            ],
            'AssetType' => 'COMPUTE',
            'ComputeAttributes' => [
                'HostId' => '<string>',
                'InstanceFamilies' => ['<string>', ...],
                'State' => 'ACTIVE|ISOLATED|RETIRING',
            ],
            'RackId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Assets
Type: Array of AssetInfo structures

Information about the hardware assets.

NextToken
Type: string

The pagination token.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

ListCapacityTasks

$result = $client->listCapacityTasks([/* ... */]);
$promise = $client->listCapacityTasksAsync([/* ... */]);

Lists the capacity tasks 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.

Parameter Syntax

$result = $client->listCapacityTasks([
    'CapacityTaskStatusFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OutpostIdentifierFilter' => '<string>',
]);

Parameter Details

Members
CapacityTaskStatusFilter
Type: Array of strings

A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.

MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

OutpostIdentifierFilter
Type: string

Filters the results by an Outpost ID or an Outpost ARN.

Result Syntax

[
    'CapacityTasks' => [
        [
            'CapacityTaskId' => '<string>',
            'CapacityTaskStatus' => 'REQUESTED|IN_PROGRESS|FAILED|COMPLETED|CANCELLED',
            'CompletionDate' => <DateTime>,
            'CreationDate' => <DateTime>,
            'LastModifiedDate' => <DateTime>,
            'OrderId' => '<string>',
            'OutpostId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CapacityTasks
Type: Array of CapacityTaskSummary structures

Lists all the capacity tasks.

NextToken
Type: string

The pagination token.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

ListCatalogItems

$result = $client->listCatalogItems([/* ... */]);
$promise = $client->listCatalogItemsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listCatalogItems([
    'EC2FamilyFilter' => ['<string>', ...],
    'ItemClassFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SupportedStorageFilter' => ['<string>', ...],
]);

Parameter Details

Members
EC2FamilyFilter
Type: Array of strings

Filters the results by EC2 family (for example, M5).

ItemClassFilter
Type: Array of strings

Filters the results by item class.

MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

SupportedStorageFilter
Type: Array of strings

Filters the results by storage option.

Result Syntax

[
    'CatalogItems' => [
        [
            'CatalogItemId' => '<string>',
            'EC2Capacities' => [
                [
                    'Family' => '<string>',
                    'MaxSize' => '<string>',
                    'Quantity' => '<string>',
                ],
                // ...
            ],
            'ItemStatus' => 'AVAILABLE|DISCONTINUED',
            'PowerKva' => <float>,
            'SupportedStorage' => ['<string>', ...],
            'SupportedUplinkGbps' => [<integer>, ...],
            'WeightLbs' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CatalogItems
Type: Array of CatalogItem structures

Information about the catalog items.

NextToken
Type: string

The pagination token.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

ListOrders

$result = $client->listOrders([/* ... */]);
$promise = $client->listOrdersAsync([/* ... */]);

Lists the Outpost orders for your Amazon Web Services account.

Parameter Syntax

$result = $client->listOrders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OutpostIdentifierFilter' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

OutpostIdentifierFilter
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Orders' => [
        [
            'LineItemCountsByStatus' => [<integer>, ...],
            'OrderFulfilledDate' => <DateTime>,
            'OrderId' => '<string>',
            'OrderSubmissionDate' => <DateTime>,
            'OrderType' => 'OUTPOST|REPLACEMENT',
            'OutpostId' => '<string>',
            'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|DELIVERED|COMPLETED|ERROR',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token.

Orders
Type: Array of OrderSummary structures

Information about the orders.

Errors

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

ListOutposts

$result = $client->listOutposts([/* ... */]);
$promise = $client->listOutpostsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listOutposts([
    'AvailabilityZoneFilter' => ['<string>', ...],
    'AvailabilityZoneIdFilter' => ['<string>', ...],
    'LifeCycleStatusFilter' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
AvailabilityZoneFilter
Type: Array of strings

Filters the results by Availability Zone (for example, us-east-1a).

AvailabilityZoneIdFilter
Type: Array of strings

Filters the results by AZ ID (for example, use1-az1).

LifeCycleStatusFilter
Type: Array of strings

Filters the results by the lifecycle status.

MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

Result Syntax

[
    'NextToken' => '<string>',
    'Outposts' => [
        [
            'AvailabilityZone' => '<string>',
            'AvailabilityZoneId' => '<string>',
            'Description' => '<string>',
            'LifeCycleStatus' => '<string>',
            'Name' => '<string>',
            'OutpostArn' => '<string>',
            'OutpostId' => '<string>',
            'OwnerId' => '<string>',
            'SiteArn' => '<string>',
            'SiteId' => '<string>',
            'SupportedHardwareType' => 'RACK|SERVER',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token.

Outposts
Type: Array of Outpost structures

Information about the Outposts.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

ListSites

$result = $client->listSites([/* ... */]);
$promise = $client->listSitesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listSites([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperatingAddressCityFilter' => ['<string>', ...],
    'OperatingAddressCountryCodeFilter' => ['<string>', ...],
    'OperatingAddressStateOrRegionFilter' => ['<string>', ...],
]);

Parameter Details

Members
MaxResults
Type: int

The maximum page size.

NextToken
Type: string

The pagination token.

OperatingAddressCityFilter
Type: Array of strings

Filters the results by city.

OperatingAddressCountryCodeFilter
Type: Array of strings

Filters the results by country code.

OperatingAddressStateOrRegionFilter
Type: Array of strings

Filters the results by state or region.

Result Syntax

[
    'NextToken' => '<string>',
    'Sites' => [
        [
            'AccountId' => '<string>',
            'Description' => '<string>',
            'Name' => '<string>',
            'Notes' => '<string>',
            'OperatingAddressCity' => '<string>',
            'OperatingAddressCountryCode' => '<string>',
            'OperatingAddressStateOrRegion' => '<string>',
            'RackPhysicalProperties' => [
                'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
                'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
                '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',
                'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
                'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
                'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
                'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
                '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',
                'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
            ],
            'SiteArn' => '<string>',
            'SiteId' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

The pagination token.

Sites
Type: Array of Site structures

Information about the sites.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

The resource tags.

Errors

InternalServerException:

An internal error has occurred.

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

StartCapacityTask

$result = $client->startCapacityTask([/* ... */]);
$promise = $client->startCapacityTaskAsync([/* ... */]);

Starts the specified capacity task. You can have one active capacity task for an order.

Parameter Syntax

$result = $client->startCapacityTask([
    'DryRun' => true || false,
    'InstancePools' => [ // REQUIRED
        [
            'Count' => <integer>, // REQUIRED
            'InstanceType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'OrderId' => '<string>', // REQUIRED
    'OutpostIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
DryRun
Type: boolean

You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

InstancePools
Required: Yes
Type: Array of InstanceTypeCapacity structures

The instance pools specified in the capacity task.

OrderId
Required: Yes
Type: string

The ID of the Amazon Web Services Outposts order associated with the specified capacity task.

OutpostIdentifier
Required: Yes
Type: string

The ID or ARN of the Outposts associated with the specified capacity task.

Result Syntax

[
    'CapacityTaskId' => '<string>',
    'CapacityTaskStatus' => 'REQUESTED|IN_PROGRESS|FAILED|COMPLETED|CANCELLED',
    'CompletionDate' => <DateTime>,
    'CreationDate' => <DateTime>,
    'DryRun' => true || false,
    'Failed' => [
        'Reason' => '<string>',
        'Type' => 'UNSUPPORTED_CAPACITY_CONFIGURATION',
    ],
    'LastModifiedDate' => <DateTime>,
    'OrderId' => '<string>',
    'OutpostId' => '<string>',
    'RequestedInstancePools' => [
        [
            'Count' => <integer>,
            'InstanceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
CapacityTaskId
Type: string

ID of the capacity task that you want to start.

CapacityTaskStatus
Type: string

Status of the specified capacity task.

CompletionDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

Date that the specified capacity task ran successfully.

CreationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

Date that the specified capacity task was created.

DryRun
Type: boolean

Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

Failed
Type: CapacityTaskFailure structure

Reason that the specified capacity task failed.

LastModifiedDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

Date that the specified capacity task was last modified.

OrderId
Type: string

ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

OutpostId
Type: string

ID of the Outpost associated with the capacity task.

RequestedInstancePools
Type: Array of InstanceTypeCapacity structures

List of the instance pools requested in the specified capacity task.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

StartConnection

$result = $client->startConnection([/* ... */]);
$promise = $client->startConnectionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startConnection([
    'AssetId' => '<string>', // REQUIRED
    'ClientPublicKey' => '<string>', // REQUIRED
    'DeviceSerialNumber' => '<string>',
    'NetworkInterfaceDeviceIndex' => <integer>, // REQUIRED
]);

Parameter Details

Members
AssetId
Required: Yes
Type: string

The ID of the Outpost server.

ClientPublicKey
Required: Yes
Type: string

The public key of the client.

DeviceSerialNumber
Type: string

The serial number of the dongle.

NetworkInterfaceDeviceIndex
Required: Yes
Type: int

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

Result Syntax

[
    'ConnectionId' => '<string>',
    'UnderlayIpAddress' => '<string>',
]

Result Details

Members
ConnectionId
Type: string

The ID of the connection.

UnderlayIpAddress
Type: string

The underlay IP address.

Errors

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

InternalServerException:

An internal error has occurred.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal error has occurred.

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

TagKeys
Required: Yes
Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

An internal error has occurred.

ValidationException:

A parameter is not valid.

NotFoundException:

The specified request is not valid.

UpdateOutpost

$result = $client->updateOutpost([/* ... */]);
$promise = $client->updateOutpostAsync([/* ... */]);

Updates an Outpost.

Parameter Syntax

$result = $client->updateOutpost([
    'Description' => '<string>',
    'Name' => '<string>',
    'OutpostId' => '<string>', // REQUIRED
    'SupportedHardwareType' => 'RACK|SERVER',
]);

Parameter Details

Members
Description
Type: string

The description of the Outpost.

Name
Type: string

The name of the Outpost.

OutpostId
Required: Yes
Type: string

The ID or ARN of the Outpost.

SupportedHardwareType
Type: string

The type of hardware for this Outpost.

Result Syntax

[
    'Outpost' => [
        'AvailabilityZone' => '<string>',
        'AvailabilityZoneId' => '<string>',
        'Description' => '<string>',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'SupportedHardwareType' => 'RACK|SERVER',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Outpost
Type: Outpost structure

Information about an Outpost.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

UpdateSite

$result = $client->updateSite([/* ... */]);
$promise = $client->updateSiteAsync([/* ... */]);

Updates the specified site.

Parameter Syntax

$result = $client->updateSite([
    'Description' => '<string>',
    'Name' => '<string>',
    'Notes' => '<string>',
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
Type: string

The description of the site.

Name
Type: string

The name of the site.

Notes
Type: string

Notes about a site.

SiteId
Required: Yes
Type: string

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

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            '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',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            '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',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
Type: Site structure

Information about a site.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

UpdateSiteAddress

$result = $client->updateSiteAddress([/* ... */]);
$promise = $client->updateSiteAddressAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateSiteAddress([
    'Address' => [ // REQUIRED
        'AddressLine1' => '<string>', // REQUIRED
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>', // REQUIRED
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>', // REQUIRED
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>', // REQUIRED
        'StateOrRegion' => '<string>', // REQUIRED
    ],
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Address
Required: Yes
Type: Address structure

The address for the site.

AddressType
Required: Yes
Type: string

The type of the address.

SiteId
Required: Yes
Type: string

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

Result Syntax

[
    'Address' => [
        'AddressLine1' => '<string>',
        'AddressLine2' => '<string>',
        'AddressLine3' => '<string>',
        'City' => '<string>',
        'ContactName' => '<string>',
        'ContactPhoneNumber' => '<string>',
        'CountryCode' => '<string>',
        'DistrictOrCounty' => '<string>',
        'Municipality' => '<string>',
        'PostalCode' => '<string>',
        'StateOrRegion' => '<string>',
    ],
    'AddressType' => 'SHIPPING_ADDRESS|OPERATING_ADDRESS',
]

Result Details

Members
Address
Type: Address structure

Information about an address.

AddressType
Type: string

The type of the address.

Errors

ValidationException:

A parameter is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

NotFoundException:

The specified request is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

InternalServerException:

An internal error has occurred.

UpdateSiteRackPhysicalProperties

$result = $client->updateSiteRackPhysicalProperties([/* ... */]);
$promise = $client->updateSiteRackPhysicalPropertiesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateSiteRackPhysicalProperties([
    'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
    'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
    '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',
    'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
    'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
    'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
    'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
    'SiteId' => '<string>', // REQUIRED
    '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',
    'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
]);

Parameter Details

Members
FiberOpticCableType
Type: string

The type of fiber that you will use to attach the Outpost to your network.

MaximumSupportedWeightLbs
Type: string

The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.

OpticalStandard
Type: 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

PowerConnector
Type: 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

PowerDrawKva
Type: string

The power draw, in kVA, available at the hardware placement position for the rack.

PowerFeedDrop
Type: string

Indicates whether the power feed comes above or below the rack.

PowerPhase
Type: 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

SiteId
Required: Yes
Type: string

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

UplinkCount
Type: 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

UplinkGbps
Type: string

The uplink speed the rack should support for the connection to the Region.

Result Syntax

[
    'Site' => [
        'AccountId' => '<string>',
        'Description' => '<string>',
        'Name' => '<string>',
        'Notes' => '<string>',
        'OperatingAddressCity' => '<string>',
        'OperatingAddressCountryCode' => '<string>',
        'OperatingAddressStateOrRegion' => '<string>',
        'RackPhysicalProperties' => [
            'FiberOpticCableType' => 'SINGLE_MODE|MULTI_MODE',
            'MaximumSupportedWeightLbs' => 'NO_LIMIT|MAX_1400_LBS|MAX_1600_LBS|MAX_1800_LBS|MAX_2000_LBS',
            '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',
            'PowerConnector' => 'L6_30P|IEC309|AH530P7W|AH532P6W',
            'PowerDrawKva' => 'POWER_5_KVA|POWER_10_KVA|POWER_15_KVA|POWER_30_KVA',
            'PowerFeedDrop' => 'ABOVE_RACK|BELOW_RACK',
            'PowerPhase' => 'SINGLE_PHASE|THREE_PHASE',
            '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',
            'UplinkGbps' => 'UPLINK_1G|UPLINK_10G|UPLINK_40G|UPLINK_100G',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
Site
Type: Site structure

Information about a site.

Errors

ValidationException:

A parameter is not valid.

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

NotFoundException:

The specified request is not valid.

AccessDeniedException:

You do not have permission to perform this operation.

InternalServerException:

An internal error has occurred.

Shapes

AccessDeniedException

Description

You do not have permission to perform this operation.

Members
Message
Type: string

Address

Description

Information about an address.

Members
AddressLine1
Required: Yes
Type: string

The first line of the address.

AddressLine2
Type: string

The second line of the address.

AddressLine3
Type: string

The third line of the address.

City
Required: Yes
Type: string

The city for the address.

ContactName
Type: string

The name of the contact.

ContactPhoneNumber
Type: string

The phone number of the contact.

CountryCode
Required: Yes
Type: string

The ISO-3166 two-letter country code for the address.

DistrictOrCounty
Type: string

The district or county for the address.

Municipality
Type: string

The municipality for the address.

PostalCode
Required: Yes
Type: string

The postal code for the address.

StateOrRegion
Required: Yes
Type: string

The state for the address.

AssetInfo

Description

Information about hardware assets.

Members
AssetId
Type: string

The ID of the asset.

AssetLocation
Type: AssetLocation structure

The position of an asset in a rack.

AssetType
Type: string

The type of the asset.

ComputeAttributes
Type: ComputeAttributes structure

Information about compute hardware assets.

RackId
Type: string

The rack ID of the asset.

AssetLocation

Description

Information about the position of the asset in a rack.

Members
RackElevation
Type: float

The position of an asset in a rack measured in rack units.

CapacityTaskFailure

Description

The capacity tasks that failed.

Members
Reason
Required: Yes
Type: string

The reason that the specified capacity task failed.

Type
Type: string

The type of failure.

CapacityTaskSummary

Description

The summary of the capacity task.

Members
CapacityTaskId
Type: string

The ID of the specified capacity task.

CapacityTaskStatus
Type: string

The status of the capacity task.

CompletionDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the specified capacity task successfully ran.

CreationDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the specified capacity task was created.

LastModifiedDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date that the specified capacity was last modified.

OrderId
Type: string

The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

OutpostId
Type: string

The ID of the Outpost associated with the specified capacity task.

CatalogItem

Description

Information about a catalog item.

Members
CatalogItemId
Type: string

The ID of the catalog item.

EC2Capacities
Type: Array of EC2Capacity structures

Information about the EC2 capacity of an item.

ItemStatus
Type: string

The status of a catalog item.

PowerKva
Type: float

Information about the power draw of an item.

SupportedStorage
Type: Array of strings

The supported storage options for the catalog item.

SupportedUplinkGbps
Type: Array of ints

The uplink speed this catalog item requires for the connection to the Region.

WeightLbs
Type: int

The weight of the item in pounds.

ComputeAttributes

Description

Information about compute hardware assets.

Members
HostId
Type: string

The host ID of the Dedicated Host on the asset.

InstanceFamilies
Type: Array of strings

A list of the names of instance families that are currently associated with a given asset.

State
Type: 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.

ConflictException

Description

Updating or deleting this resource can cause an inconsistent state.

Members
Message
Type: string
ResourceId
Type: string

The ID of the resource causing the conflict.

ResourceType
Type: string

The type of the resource causing the conflict.

ConnectionDetails

Description

Information about a connection.

Members
AllowedIps
Type: Array of strings

The allowed IP addresses.

ClientPublicKey
Type: string

The public key of the client.

ClientTunnelAddress
Type: string

The client tunnel address.

ServerEndpoint
Type: string

The endpoint for the server.

ServerPublicKey
Type: string

The public key of the server.

ServerTunnelAddress
Type: string

The server tunnel address.

EC2Capacity

Description

Information about EC2 capacity.

Members
Family
Type: string

The family of the EC2 capacity.

MaxSize
Type: string

The maximum size of the EC2 capacity.

Quantity
Type: string

The quantity of the EC2 capacity.

InstanceTypeCapacity

Description

The instance type that you specify determines the combination of CPU, memory, storage, and networking capacity.

Members
Count
Required: Yes
Type: int

The number of instances for the specified instance type.

InstanceType
Required: Yes
Type: string

The instance type of the hosts.

InstanceTypeItem

Description

Information about an instance type.

Members
InstanceType
Type: string

The instance type.

VCPUs
Type: int

The number of default VCPUs in an instance type.

InternalServerException

Description

An internal error has occurred.

Members
Message
Type: string

LineItem

Description

Information about a line item.

Members
AssetInformationList
Type: Array of LineItemAssetInformation structures

Information about assets.

CatalogItemId
Type: string

The ID of the catalog item.

LineItemId
Type: string

The ID of the line item.

PreviousLineItemId
Type: string

The ID of the previous line item.

PreviousOrderId
Type: string

The ID of the previous order.

Quantity
Type: int

The quantity of the line item.

ShipmentInformation
Type: ShipmentInformation structure

Information about a line item shipment.

Status
Type: string

The status of the line item.

LineItemAssetInformation

Description

Information about a line item asset.

Members
AssetId
Type: string

The ID of the asset.

MacAddressList
Type: Array of strings

The MAC addresses of the asset.

LineItemRequest

Description

Information about a line item request.

Members
CatalogItemId
Type: string

The ID of the catalog item.

Quantity
Type: int

The quantity of a line item request.

NotFoundException

Description

The specified request is not valid.

Members
Message
Type: string

Order

Description

Information about an order.

Members
LineItems
Type: Array of LineItem structures

The line items for the order

OrderFulfilledDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The fulfillment date of the order.

OrderId
Type: string

The ID of the order.

OrderSubmissionDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The submission date for the order.

OrderType
Type: string

The type of order.

OutpostId
Type: string

The ID of the Outpost in the order.

PaymentOption
Type: string

The payment option for the order.

PaymentTerm
Type: string

The payment term.

Status
Type: string

The status of the order.

  • PREPARING - Order is received and being prepared.

  • IN_PROGRESS - Order is either being built or shipped. To get more details, see the line item status.

  • DELIVERED - Order was delivered to the Outpost site.

  • COMPLETED - Order is complete.

  • CANCELLED - Order is cancelled.

  • ERROR - Customer should contact support.

The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

OrderSummary

Description

A summary of line items in your order.

Members
LineItemCountsByStatus
Type: Associative array of custom strings keys (LineItemStatus) to ints

The status of all line items in the order.

OrderFulfilledDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The fulfilment date for the order.

OrderId
Type: string

The ID of the order.

OrderSubmissionDate
Type: timestamp (string|DateTime or anything parsable by strtotime)

The submission date for the order.

OrderType
Type: string

The type of order.

OutpostId
Type: string

The ID of the Outpost.

Status
Type: 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.

The following statuses are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.

Outpost

Description

Information about an Outpost.

Members
AvailabilityZone
Type: string

The Availability Zone.

AvailabilityZoneId
Type: string

The ID of the Availability Zone.

Description
Type: string

The description of the Outpost.

LifeCycleStatus
Type: string

The life cycle status.

Name
Type: string

The name of the Outpost.

OutpostArn
Type: string

The Amazon Resource Name (ARN) of the Outpost.

OutpostId
Type: string

The ID of the Outpost.

OwnerId
Type: string

The Amazon Web Services account ID of the Outpost owner.

SiteArn
Type: string

The Amazon Resource Name (ARN) of the site.

SiteId
Type: string

The ID of the site.

SupportedHardwareType
Type: string

The hardware type.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The Outpost tags.

RackPhysicalProperties

Description

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 Amazon Web Services Outposts User Guide.

Members
FiberOpticCableType
Type: string

The type of fiber used to attach the Outpost to the network.

MaximumSupportedWeightLbs
Type: string

The maximum rack weight that this site can support. NO_LIMIT is over 2000 lbs (907 kg).

OpticalStandard
Type: 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.

PowerConnector
Type: string

The power connector for the hardware.

PowerDrawKva
Type: string

The power draw available at the hardware placement position for the rack.

PowerFeedDrop
Type: string

The position of the power feed.

PowerPhase
Type: string

The power option that you can provide for hardware.

UplinkCount
Type: string

The number of uplinks each Outpost network device.

UplinkGbps
Type: string

The uplink speed the rack supports for the connection to the Region.

ServiceQuotaExceededException

Description

You have exceeded a service quota.

Members
Message
Type: string

ShipmentInformation

Description

Information about a line item shipment.

Members
ShipmentCarrier
Type: string

The carrier of the shipment.

ShipmentTrackingNumber
Type: string

The tracking number of the shipment.

Site

Description

Information about a site.

Members
AccountId
Type: string

The ID of the Amazon Web Services account.

Description
Type: string

The description of the site.

Name
Type: string

The name of the site.

Notes
Type: string

Notes about a site.

OperatingAddressCity
Type: string

City where the hardware is installed and powered on.

OperatingAddressCountryCode
Type: string

The ISO-3166 two-letter country code where the hardware is installed and powered on.

OperatingAddressStateOrRegion
Type: string

State or region where the hardware is installed and powered on.

RackPhysicalProperties
Type: RackPhysicalProperties structure

Information about the physical and logistical details for a rack at the site.

SiteArn
Type: string

The Amazon Resource Name (ARN) of the site.

SiteId
Type: string

The ID of the site.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The site tags.

ValidationException

Description

A parameter is not valid.

Members
Message
Type: string