AWS Outposts 2019-12-03
- 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 */).
- CreateOrder ( array $params = [] )
Creates an order for an Outpost.
- CreateOutpost ( array $params = [] )
Creates an Outpost.
- DeleteOutpost ( array $params = [] )
Deletes the Outpost.
- DeleteSite ( array $params = [] )
Deletes the site.
- GetOutpost ( array $params = [] )
Gets information about the specified Outpost.
- GetOutpostInstanceTypes ( array $params = [] )
Lists the instance types for the specified Outpost.
- ListOutposts ( array $params = [] )
Create a list of the Outposts for your AWS account.
- ListSites ( array $params = [] )
Lists the sites for the specified AWS account.
- ListTagsForResource ( array $params = [] )
Lists the tags for the specified resource.
- TagResource ( array $params = [] )
Adds tags to the specified resource.
- UntagResource ( array $params = [] )
Removes tags from the specified resource.
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:
Operations
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',
]);
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 for the order.
- PaymentTerm
-
- Type: string
The payment terms for the order.
Result Syntax
[
'Order' => [
'LineItems' => [
[
'CatalogItemId' => '<string>',
'LineItemId' => '<string>',
'Quantity' => <integer>,
'Status' => '<string>',
],
// ...
],
'OrderFulfilledDate' => <DateTime>,
'OrderId' => '<string>',
'OrderSubmissionDate' => <DateTime>,
'OutpostId' => '<string>',
'PaymentOption' => 'ALL_UPFRONT|NO_UPFRONT|PARTIAL_UPFRONT',
'Status' => 'RECEIVED|PENDING|PROCESSING|INSTALLING|FULFILLED|CANCELLED',
],
]
Result Details
Members
- Order
-
- Type: Order structure
Information about this order.
Errors
-
A parameter is not valid.
-
Updating or deleting this resource can cause an inconsistent state.
-
You do not have permission to perform this operation.
-
The specified request is not valid.
-
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 AvailabilityZone or AvailabilityZoneId.
Parameter Syntax
$result = $client->createOutpost([
'AvailabilityZone' => '<string>',
'AvailabilityZoneId' => '<string>',
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'SiteId' => '<string>', // REQUIRED
'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 of the site.
- 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>',
'Tags' => ['<string>', ...],
],
]
Result Details
Members
- Outpost
-
- Type: Outpost structure
Information about an Outpost.
Errors
-
A parameter is not valid.
-
Updating or deleting this resource can cause an inconsistent state.
-
The specified request is not valid.
-
You do not have permission to perform this operation.
-
An internal error has occurred.
-
ServiceQuotaExceededException:
You have exceeded a service quota.
DeleteOutpost
$result = $client->deleteOutpost([/* ... */]); $promise = $client->deleteOutpostAsync([/* ... */]);
Deletes the Outpost.
Parameter Syntax
$result = $client->deleteOutpost([
'OutpostId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
A parameter is not valid.
-
Updating or deleting this resource can cause an inconsistent state.
-
The specified request is not valid.
-
You do not have permission to perform this operation.
-
An internal error has occurred.
DeleteSite
$result = $client->deleteSite([/* ... */]); $promise = $client->deleteSiteAsync([/* ... */]);
Deletes the site.
Parameter Syntax
$result = $client->deleteSite([
'SiteId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
A parameter is not valid.
-
Updating or deleting this resource can cause an inconsistent state.
-
The specified request is not valid.
-
You do not have permission to perform this operation.
-
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>',
'Tags' => ['<string>', ...],
],
]
Result Details
Members
- Outpost
-
- Type: Outpost structure
Information about an Outpost.
Errors
-
A parameter is not valid.
-
The specified request is not valid.
-
You do not have permission to perform this operation.
-
An internal error has occurred.
GetOutpostInstanceTypes
$result = $client->getOutpostInstanceTypes([/* ... */]); $promise = $client->getOutpostInstanceTypesAsync([/* ... */]);
Lists the instance types for the specified Outpost.
Parameter Syntax
$result = $client->getOutpostInstanceTypes([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'OutpostId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'InstanceTypes' => [
[
'InstanceType' => '<string>',
],
// ...
],
'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
-
A parameter is not valid.
-
The specified request is not valid.
-
You do not have permission to perform this operation.
-
An internal error has occurred.
ListOutposts
$result = $client->listOutposts([/* ... */]); $promise = $client->listOutpostsAsync([/* ... */]);
Create a list of the Outposts for your AWS account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availibility Zone (us-east-1a), and AZ ID (use1-az1).
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
Parameter Syntax
$result = $client->listOutposts([
'AvailabilityZoneFilter' => ['<string>', ...],
'AvailabilityZoneIdFilter' => ['<string>', ...],
'LifeCycleStatusFilter' => ['<string>', ...],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AvailabilityZoneFilter
-
- Type: Array of strings
A filter for the Availibility Zone (
us-east-1a) of the Outpost.Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an
OR, and the request returns all results that match any of the specified values. - AvailabilityZoneIdFilter
-
- Type: Array of strings
A filter for the AZ IDs (
use1-az1) of the Outpost.Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an
OR, and the request returns all results that match any of the specified values. - LifeCycleStatusFilter
-
- Type: Array of strings
A filter for the lifecycle status of the Outpost.
Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an
OR, and the request returns all results that match any of the specified values. - 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>',
'Tags' => ['<string>', ...],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The pagination token.
- Outposts
-
- Type: Array of Outpost structures
Information about the Outposts.
Errors
-
A parameter is not valid.
-
You do not have permission to perform this operation.
-
An internal error has occurred.
ListSites
$result = $client->listSites([/* ... */]); $promise = $client->listSitesAsync([/* ... */]);
Lists the sites for the specified AWS account.
Parameter Syntax
$result = $client->listSites([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'NextToken' => '<string>',
'Sites' => [
[
'AccountId' => '<string>',
'Description' => '<string>',
'Name' => '<string>',
'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
-
A parameter is not valid.
-
You do not have permission to perform this operation.
-
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
-
An internal error has occurred.
-
A parameter is not valid.
-
The specified request is not valid.
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
Result Syntax
[]
Result Details
Errors
-
An internal error has occurred.
-
A parameter is not valid.
-
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
Result Syntax
[]
Result Details
Errors
-
An internal error has occurred.
-
A parameter is not valid.
-
The specified request is not valid.
Shapes
AccessDeniedException
ConflictException
Description
Updating or deleting this resource can cause an inconsistent state.
Members
InstanceTypeItem
Description
Information about an instance type.
Members
InternalServerException
LineItem
Description
Information about a line item.
Members
LineItemRequest
Description
Information about a line item request.
Members
NotFoundException
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.
- OutpostId
-
- Type: string
The ID of the Outpost.
- PaymentOption
-
- Type: string
The payment option for the order.
- Status
-
- Type: string
The status of the order
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 AWS 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.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The Outpost tags.
ServiceQuotaExceededException
Site
Description
Information about a site.
Members
- AccountId
-
- Type: string
The ID of the AWS account.
- Description
-
- Type: string
The description of the site.
- Name
-
- Type: string
The name of 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.