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 */).
- 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 = [] )
List the Outposts for your AWS account.
- ListSites ( array $params = [] )
Lists the sites for the specified AWS account.
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
CreateOutpost
$result = $client->createOutpost([/* ... */]); $promise = $client->createOutpostAsync([/* ... */]);
Creates an Outpost.
Parameter Syntax
$result = $client->createOutpost([
'AvailabilityZone' => '<string>',
'AvailabilityZoneId' => '<string>',
'Description' => '<string>',
'Name' => '<string>',
'SiteId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AvailabilityZone
-
- Type: string
The Availability Zone.
You must specify
AvailabilityZoneorAvailabilityZoneId. - AvailabilityZoneId
-
- Type: string
The ID of the Availability Zone.
You must specify
AvailabilityZoneorAvailabilityZoneId. - Description
-
- Type: string
The Outpost description.
- Name
-
- Type: string
The name of the Outpost.
- SiteId
-
- Required: Yes
- Type: string
The ID of the site.
Result Syntax
[
'Outpost' => [
'AvailabilityZone' => '<string>',
'AvailabilityZoneId' => '<string>',
'Description' => '<string>',
'LifeCycleStatus' => '<string>',
'Name' => '<string>',
'OutpostArn' => '<string>',
'OutpostId' => '<string>',
'OwnerId' => '<string>',
'SiteId' => '<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.
-
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.
-
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.
-
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>',
'SiteId' => '<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([/* ... */]);
List the Outposts for your AWS account.
Parameter Syntax
$result = $client->listOutposts([
'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>',
'SiteId' => '<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>',
'SiteId' => '<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.
Shapes
AccessDeniedException
InstanceTypeItem
Description
Information about an instance type.
Members
InternalServerException
NotFoundException
Outpost
Description
Information about an Outpost.
Members
- AvailabilityZone
-
- Type: string
The Availability Zone.
You must specify
AvailabilityZoneorAvailabilityZoneId. - AvailabilityZoneId
-
- Type: string
The ID of the Availability Zone.
You must specify
AvailabilityZoneorAvailabilityZoneId. - Description
-
- Type: string
The Outpost description.
- 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.
- SiteId
-
- Type: string
The ID of the site.
ServiceQuotaExceededException
Site
Description
Information about a site.
