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' => [
        [
            'CatalogItemId' => '<string>',
            'Quantity' => <integer>,
        ],
        // ...
    ],
    'OutpostIdentifier' => '<string>', // REQUIRED
    'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT', // REQUIRED
    'PaymentTerm' => 'THREE_YEARS|ONE_YEAR|FIVE_YEARS',
    'QuoteIdentifier' => '<string>',
    'QuoteOptionIdentifier' => '<string>',
]);

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|FIVE_YEARS',
        'QuoteIdentifier' => '<string>',
        'QuoteOptionIdentifier' => '<string>',
        'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED|PREPARING|IN_PROGRESS|DELIVERED|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>',
        'Generation' => 'GENERATION_2|GENERATION_1',
        'LifeCycleStatus' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'OutpostId' => '<string>',
        'OwnerId' => '<string>',
        'RackScalingType' => 'SINGLE_RACK|MULTI_RACK',
        '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.

CreatePrivateConnectivityConfig

$result = $client->createPrivateConnectivityConfig([/* ... */]);
$promise = $client->createPrivateConnectivityConfigAsync([/* ... */]);

Creates the private connectivity configuration for the specified Outpost. Private connectivity establishes a service link VPN connection between the Outpost and its home Amazon Web Services Region using a VPC and subnet that you specify, which allows the service link traffic to flow through your VPC and minimizes public internet exposure.

Parameter Syntax

$result = $client->createPrivateConnectivityConfig([
    'OutpostId' => '<string>', // REQUIRED
    'VpcInformationList' => [ // REQUIRED
        [
            'SubnetIds' => ['<string>', ...],
            'VpcEndpointId' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'OutpostId' => '<string>',
    'PrivateConnectivityConfig' => [
        'PrivateConnectivityStatus' => 'ENABLED|DISABLED',
        'ProvisioningRoleArn' => '<string>',
        'RoleArn' => '<string>',
        'VpcInformationList' => [
            [
                'SubnetIds' => ['<string>', ...],
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ConflictException:

Updating or deleting this resource can cause an inconsistent state.

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.

CreateQuote

$result = $client->createQuote([/* ... */]);
$promise = $client->createQuoteAsync([/* ... */]);

Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities.

Parameter Syntax

$result = $client->createQuote([
    'CountryCode' => '<string>', // REQUIRED
    'Description' => '<string>',
    'OutpostIdentifier' => '<string>',
    'RequestedCapacities' => [ // REQUIRED
        [
            'Quantity' => <float>,
            'QuoteCapacityType' => 'EC2|EBS|S3',
            'Unit' => '<string>',
        ],
        // ...
    ],
    'RequestedConstraints' => [
        [
            'QuoteConstraintType' => 'RACK_MAXIMUM|RACK_MAX_POWER_KVA|RACK_MAX_WEIGHT_LBS|RACK_SPACE_CONSTRAINED',
            'Value' => '<string>',
        ],
        // ...
    ],
    'RequestedPaymentOptions' => ['<string>', ...],
    'RequestedPaymentTerms' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Quote' => [
        'AccountId' => '<string>',
        'CountryCode' => '<string>',
        'CreatedDate' => <DateTime>,
        'Description' => '<string>',
        'ExpirationDate' => <DateTime>,
        'OrderingRequirements' => [
            [
                'OrderingRequirementType' => 'OUTPOST_ACTIVE_CHECK_ERROR|MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR|VALID_ZIP_CODE_CHECK_ERROR|RACK_PHYSICAL_PROPERTIES_CHECK_ERROR|OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR|SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR|COUNTRY_CODE_MISMATCH_CHECK_ERROR|OUTPOST_GENERATION_MISMATCH_ERROR|UNSUPPORTED|OUTPOST_ID_MISSING_ON_QUOTE_ERROR|ENTERPRISE_SUPPORT_ERROR|SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR|SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR|SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR|OUTPOST_STATE_CHANGED_ERROR|OUTPOST_NOT_FOUND_ERROR|OUTPOST_RENEWAL_REQUIRED_ERROR',
                'Status' => 'PASS|FAIL|EXEMPT',
                'StatusMessage' => '<string>',
            ],
            // ...
        ],
        'OutpostArn' => '<string>',
        'QuoteId' => '<string>',
        'QuoteOptions' => [
            [
                'Capacities' => [
                    [
                        'Quantity' => <float>,
                        'QuoteCapacityType' => 'EC2|EBS|S3',
                        'Unit' => '<string>',
                    ],
                    // ...
                ],
                'CapacitySummary' => [
                    'CapacityChange' => [
                        [
                            'Quantity' => <float>,
                            'QuoteCapacityType' => 'EC2|EBS|S3',
                            'Unit' => '<string>',
                        ],
                        // ...
                    ],
                    'ExistingCapacities' => [
                        [
                            'Quantity' => <float>,
                            'QuoteCapacityType' => 'EC2|EBS|S3',
                            'Unit' => '<string>',
                        ],
                        // ...
                    ],
                    'FinalCapacities' => [
                        [
                            'Quantity' => <float>,
                            'QuoteCapacityType' => 'EC2|EBS|S3',
                            'Unit' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'PricingOptions' => [
                    [
                        'PricingType' => 'SUBSCRIPTION',
                        'SubscriptionPricingDetails' => [
                            'Currency' => 'USD',
                            'MonthlyRecurringPrice' => <float>,
                            'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
                            'PaymentTerm' => 'THREE_YEARS|ONE_YEAR|FIVE_YEARS',
                            'UpfrontPrice' => <float>,
                        ],
                    ],
                    // ...
                ],
                'QuoteOptionIdentifier' => '<string>',
                'Specifications' => [
                    [
                        'ExistingRackSpecificationDetails' => [
                            'EC2Capacities' => [
                                [
                                    'Family' => '<string>',
                                    'MaxSize' => '<string>',
                                    'Quantity' => '<string>',
                                ],
                                // ...
                            ],
                            'RackDepthInches' => <float>,
                            'RackHeightInches' => <float>,
                            'RackId' => '<string>',
                            'RackPowerDrawKva' => <float>,
                            'RackUnitHeight' => 'HEIGHT_42U|HEIGHT_2U|HEIGHT_1U',
                            'RackUse' => 'NETWORKING|COMPUTE',
                            'RackWeightLbs' => <float>,
                            'RackWidthInches' => <float>,
                        ],
                        'FinalRackSpecificationDetails' => [
                            'EC2Capacities' => [
                                [
                                    'Family' => '<string>',
                                    'MaxSize' => '<string>',
                                    'Quantity' => '<string>',
                                ],
                                // ...
                            ],
                            'RackDepthInches' => <float>,
                            'RackHeightInches' => <float>,
                            'RackId' => '<string>',
                            'RackPowerDrawKva' => <float>,
                            'RackUnitHeight' => 'HEIGHT_42U|HEIGHT_2U|HEIGHT_1U',
                            'RackUse' => 'NETWORKING|COMPUTE',
                            'RackWeightLbs' => <float>,
                            'RackWidthInches' => <float>,
                        ],
                        'QuoteSpecificationType' => 'UPDATED_RACK|NEW_RACK|EXISTING_RACK|SERVER',
                        'ServerSpecificationDetails' => [
                            'EC2Capacities' => [
                                [
                                    'Family' => '<string>',
                                    'MaxSize' => '<string>',
                                    'Quantity' => '<string>',
                                ],
                                // ...
                            ],
                            'RackUnitHeight' => 'HEIGHT_42U|HEIGHT_2U|HEIGHT_1U',
                            'ServerDepthInches' => <float>,
                            'ServerHeightInches' => <float>,
                            'ServerPowerDrawKva' => <float>,
                            'ServerWeightLbs' => <float>,
                            'ServerWidthInches' => <float>,
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'QuoteStatus' => 'CREATED|ORDER_SUBMITTED|EXPIRED',
        'RequestedCapacities' => [
            [
                'Quantity' => <float>,
                'QuoteCapacityType' => 'EC2|EBS|S3',
                'Unit' => '<string>',
            ],
            // ...
        ],
        'RequestedConstraints' => [
            [
                'QuoteConstraintType' => 'RACK_MAXIMUM|RACK_MAX_POWER_KVA|RACK_MAX_WEIGHT_LBS|RACK_SPACE_CONSTRAINED',
                'Value' => '<string>',
            ],
            // ...
        ],
        'RequestedPaymentOptions' => ['<string>', ...],
        'RequestedPaymentTerms' => ['<string>', ...],
        'StatusMessage' => '<string>',
        'SubmittedOrderId' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have permission to perform this operation.

ValidationException:

A parameter is not valid.

InternalServerException:

An internal error has occurred.

NotFoundException:

The specified request is not valid.

CreateRenewal

$result = $client->createRenewal([/* ... */]);
$promise = $client->createRenewalAsync([/* ... */]);

Creates a renewal contract for the specified Outpost.

Parameter Syntax

$result = $client->createRenewal([
    'ClientToken' => '<string>',
    'OutpostIdentifier' => '<string>', // REQUIRED
    'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT', // REQUIRED
    'PaymentTerm' => 'THREE_YEARS|ONE_YEAR|FIVE_YEARS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Currency' => 'USD',
    'MonthlyRecurringPrice' => <float>,
    'OutpostId' => '<string>',
    'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
    'PaymentTerm' => 'THREE_YEARS|ONE_YEAR|FIVE_YEARS',
    'UpfrontPrice' => <float>,
]

Result Details

Errors