SDK for PHP 3.x

Amazon S3 on Outposts 2017-07-25

Client: Aws\S3Outposts\S3OutpostsClient
Service ID: s3outposts
Version: 2017-07-25

This page describes the parameters and results for the operations of the Amazon S3 on Outposts (2017-07-25), and shows how to use the Aws\S3Outposts\S3OutpostsClient object to call the described operations. This documentation is specific to the 2017-07-25 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 */).

CreateEndpoint ( array $params = [] )
Creates an endpoint and associates it with the specified Outpost.
DeleteEndpoint ( array $params = [] )
Deletes an endpoint.
ListEndpoints ( array $params = [] )
Lists endpoints associated with the specified Outpost.
ListOutpostsWithS3 ( array $params = [] )
Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account.
ListSharedEndpoints ( array $params = [] )
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

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:

ListEndpoints
ListOutpostsWithS3
ListSharedEndpoints

Operations

CreateEndpoint 

$result = $client->createEndpoint([/* ... */]);
$promise = $client->createEndpointAsync([/* ... */]);

Creates an endpoint and associates it with the specified Outpost.

It can take up to 5 minutes for this action to finish.

Related actions include:

Parameter Syntax

$result = $client->createEndpoint([
    'AccessType' => 'Private|CustomerOwnedIp',
    'CustomerOwnedIpv4Pool' => '<string>',
    'OutpostId' => '<string>', // REQUIRED
    'SecurityGroupId' => '<string>', // REQUIRED
    'SubnetId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AccessType
Type: string

The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose Private. To use the endpoint with an on-premises network, choose CustomerOwnedIp. If you choose CustomerOwnedIp, you must also provide the customer-owned IP address pool (CoIP pool).

Private is the default access type value.

CustomerOwnedIpv4Pool
Type: string

The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

OutpostId
Required: Yes
Type: string

The ID of the Outposts.

SecurityGroupId
Required: Yes
Type: string

The ID of the security group to use with the endpoint.

SubnetId
Required: Yes
Type: string

The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

Result Syntax

[
    'EndpointArn' => '<string>',
]

Result Details

Members
EndpointArn
Type: string

The Amazon Resource Name (ARN) of the endpoint.

Errors

InternalServerException:

There was an exception with the internal server.

ValidationException:

There was an exception validating this data.

AccessDeniedException:

Access was denied for this action.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

There was a conflict with this action, and it could not be completed.

ThrottlingException:

The request was denied due to request throttling.

OutpostOfflineException:

The service link connection to your Outposts home Region is down. Check your connection and try again.

DeleteEndpoint 

$result = $client->deleteEndpoint([/* ... */]);
$promise = $client->deleteEndpointAsync([/* ... */]);

Deletes an endpoint.

It can take up to 5 minutes for this action to finish.

Related actions include:

Parameter Syntax

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

Parameter Details

Members
EndpointId
Required: Yes
Type: string

The ID of the endpoint.

OutpostId
Required: Yes
Type: string

The ID of the Outposts.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:

There was an exception with the internal server.

AccessDeniedException:

Access was denied for this action.

ResourceNotFoundException:

The requested resource was not found.

ValidationException:

There was an exception validating this data.

ThrottlingException:

The request was denied due to request throttling.

OutpostOfflineException:

The service link connection to your Outposts home Region is down. Check your connection and try again.

ListEndpoints 

$result = $client->listEndpoints([/* ... */]);
$promise = $client->listEndpointsAsync([/* ... */]);

Lists endpoints associated with the specified Outpost.

Related actions include:

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int

The maximum number of endpoints that will be returned in the response.

NextToken
Type: string

If a previous response from this operation included a NextToken value, provide that value here to retrieve the next page of results.

Result Syntax

[
    'Endpoints' => [
        [
            'AccessType' => 'Private|CustomerOwnedIp',
            'CidrBlock' => '<string>',
            'CreationTime' => <DateTime>,
            'CustomerOwnedIpv4Pool' => '<string>',
            'EndpointArn' => '<string>',
            'FailedReason' => [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
            ],
            'NetworkInterfaces' => [
                [
                    'NetworkInterfaceId' => '<string>',
                ],
                // ...
            ],
            'OutpostsId' => '<string>',
            'SecurityGroupId' => '<string>',
            'Status' => 'Pending|Available|Deleting|Create_Failed|Delete_Failed',
            'SubnetId' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Endpoints
Type: Array of Endpoint structures

The list of endpoints associated with the specified Outpost.

NextToken
Type: string

If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.

Errors

InternalServerException:

There was an exception with the internal server.

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

Access was denied for this action.

ValidationException:

There was an exception validating this data.

ThrottlingException:

The request was denied due to request throttling.

ListOutpostsWithS3 

$result = $client->listOutpostsWithS3([/* ... */]);
$promise = $client->listOutpostsWithS3Async([/* ... */]);

Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager (RAM).

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int

The maximum number of Outposts to return. The limit is 100.

NextToken
Type: string

When you can get additional results from the ListOutpostsWithS3 call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional Outposts.

Result Syntax

[
    'NextToken' => '<string>',
    'Outposts' => [
        [
            'CapacityInBytes' => <integer>,
            'OutpostArn' => '<string>',
            'OutpostId' => '<string>',
            'OwnerId' => '<string>',
            'S3OutpostArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

Returns a token that you can use to call ListOutpostsWithS3 again and receive additional results, if there are any.

Outposts
Type: Array of Outpost structures

Returns the list of Outposts that have the following characteristics:

  • outposts that have S3 provisioned

  • outposts that are Active (not pending any provisioning nor decommissioned)

  • outposts to which the the calling Amazon Web Services account has access

Errors

InternalServerException:

There was an exception with the internal server.

AccessDeniedException:

Access was denied for this action.

ValidationException:

There was an exception validating this data.

ThrottlingException:

The request was denied due to request throttling.

ListSharedEndpoints 

$result = $client->listSharedEndpoints([/* ... */]);
$promise = $client->listSharedEndpointsAsync([/* ... */]);

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).

Related actions include:

Parameter Syntax

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

Parameter Details

Members
MaxResults
Type: int

The maximum number of endpoints that will be returned in the response.

NextToken
Type: string

If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.

OutpostId
Required: Yes
Type: string

The ID of the Amazon Web Services Outpost.

Result Syntax

[
    'Endpoints' => [
        [
            'AccessType' => 'Private|CustomerOwnedIp',
            'CidrBlock' => '<string>',
            'CreationTime' => <DateTime>,
            'CustomerOwnedIpv4Pool' => '<string>',
            'EndpointArn' => '<string>',
            'FailedReason' => [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
            ],
            'NetworkInterfaces' => [
                [
                    'NetworkInterfaceId' => '<string>',
                ],
                // ...
            ],
            'OutpostsId' => '<string>',
            'SecurityGroupId' => '<string>',
            'Status' => 'Pending|Available|Deleting|Create_Failed|Delete_Failed',
            'SubnetId' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Endpoints
Type: Array of Endpoint structures

The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).

NextToken
Type: string

If the number of endpoints associated with the specified Outpost exceeds MaxResults, you can include this value in subsequent calls to this operation to retrieve more results.

Errors

InternalServerException:

There was an exception with the internal server.

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

Access was denied for this action.

ValidationException:

There was an exception validating this data.

ThrottlingException:

The request was denied due to request throttling.

Shapes

AccessDeniedException

Description

Access was denied for this action.

Members
Message
Type: string

ConflictException

Description

There was a conflict with this action, and it could not be completed.

Members
Message
Type: string

Endpoint

Description

Amazon S3 on Outposts Access Points simplify managing data access at scale for shared datasets in S3 on Outposts. S3 on Outposts uses endpoints to connect to Outposts buckets so that you can perform actions within your virtual private cloud (VPC). For more information, see Accessing S3 on Outposts using VPC-only access points in the Amazon Simple Storage Service User Guide.

Members
AccessType
Type: string

The type of connectivity used to access the Amazon S3 on Outposts endpoint.

CidrBlock
Type: string

The VPC CIDR committed by this endpoint.

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

The time the endpoint was created.

CustomerOwnedIpv4Pool
Type: string

The ID of the customer-owned IPv4 address pool used for the endpoint.

EndpointArn
Type: string

The Amazon Resource Name (ARN) of the endpoint.

FailedReason
Type: FailedReason structure

The failure reason, if any, for a create or delete endpoint operation.

NetworkInterfaces
Type: Array of NetworkInterface structures

The network interface of the endpoint.

OutpostsId
Type: string

The ID of the Outposts.

SecurityGroupId
Type: string

The ID of the security group used for the endpoint.

Status
Type: string

The status of the endpoint.

SubnetId
Type: string

The ID of the subnet used for the endpoint.

VpcId
Type: string

The ID of the VPC used for the endpoint.

FailedReason

Description

The failure reason, if any, for a create or delete endpoint operation.

Members
ErrorCode
Type: string

The failure code, if any, for a create or delete endpoint operation.

Message
Type: string

Additional error details describing the endpoint failure and recommended action.

InternalServerException

Description

There was an exception with the internal server.

Members
Message
Type: string

NetworkInterface

Description

The container for the network interface.

Members
NetworkInterfaceId
Type: string

The ID for the network interface.

Outpost

Description

Contains the details for the Outpost object.

Members
CapacityInBytes
Type: long (int|float)

The Amazon S3 capacity of the outpost in bytes.

OutpostArn
Type: string

Specifies the unique Amazon Resource Name (ARN) for the outpost.

OutpostId
Type: string

Specifies the unique identifier for the outpost.

OwnerId
Type: string

Returns the Amazon Web Services account ID of the outpost owner. Useful for comparing owned versus shared outposts.

S3OutpostArn
Type: string

Specifies the unique S3 on Outposts ARN for use with Resource Access Manager (RAM).

OutpostOfflineException

Description

The service link connection to your Outposts home Region is down. Check your connection and try again.

Members
Message
Type: string

ResourceNotFoundException

Description

The requested resource was not found.

Members
Message
Type: string

ThrottlingException

Description

The request was denied due to request throttling.

Members
Message
Type: string

ValidationException

Description

There was an exception validating this data.

Members
Message
Type: string