CancelCapacityTask

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

Cancels the capacity task.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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|COMPLETED|ERROR',
    ],
]

Result Details

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

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

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

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

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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|COMPLETED|ERROR',
    ],
]

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

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

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

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

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

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

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

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|COMPLETED|ERROR',
        ],
        // ...
    ],
]

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

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

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.