A low-level client representing Amazon S3 on Outposts (S3 Outposts)
Amazon S3 on Outposts provides access to S3 on Outposts operations.
client = session.create_client('s3outposts')
These are the available methods:
Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
Closes underlying endpoint connections.
Creates an endpoint and associates it with the specified Outpost.
Note
It can take up to 5 minutes for this action to finish.
Related actions include:
See also: AWS API Documentation
Request Syntax
response = client.create_endpoint(
OutpostId='string',
SubnetId='string',
SecurityGroupId='string',
AccessType='Private'|'CustomerOwnedIp',
CustomerOwnedIpv4Pool='string'
)
OutpostId (string) –
[REQUIRED]
The ID of the Outposts.
SubnetId (string) –
[REQUIRED]
The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.
SecurityGroupId (string) –
[REQUIRED]
The ID of the security group to use with the endpoint.
AccessType (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).
Note
Private
is the default access type value.
CustomerOwnedIpv4Pool (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.
dict
Response Syntax
{
'EndpointArn': 'string'
}
Response Structure
(dict) –
EndpointArn (string) –
The Amazon Resource Name (ARN) of the endpoint.
Exceptions
Deletes an endpoint.
Note
It can take up to 5 minutes for this action to finish.
Related actions include:
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint(
EndpointId='string',
OutpostId='string'
)
EndpointId (string) –
[REQUIRED]
The ID of the endpoint.
OutpostId (string) –
[REQUIRED]
The ID of the Outposts.
None
Exceptions
Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
Lists endpoints associated with the specified Outpost.
Related actions include:
See also: AWS API Documentation
Request Syntax
response = client.list_endpoints(
NextToken='string',
MaxResults=123
)
NextToken (string) – If a previous response from this operation included a NextToken
value, provide that value here to retrieve the next page of results.
MaxResults (integer) – The maximum number of endpoints that will be returned in the response.
dict
Response Syntax
{
'Endpoints': [
{
'EndpointArn': 'string',
'OutpostsId': 'string',
'CidrBlock': 'string',
'Status': 'Pending'|'Available'|'Deleting',
'CreationTime': datetime(2015, 1, 1),
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string'
},
],
'VpcId': 'string',
'SubnetId': 'string',
'SecurityGroupId': 'string',
'AccessType': 'Private'|'CustomerOwnedIp',
'CustomerOwnedIpv4Pool': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Endpoints (list) –
The list of endpoints associated with the specified Outpost.
(dict) –
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 .
EndpointArn (string) –
The Amazon Resource Name (ARN) of the endpoint.
OutpostsId (string) –
The ID of the Outposts.
CidrBlock (string) –
The VPC CIDR committed by this endpoint.
Status (string) –
The status of the endpoint.
CreationTime (datetime) –
The time the endpoint was created.
NetworkInterfaces (list) –
The network interface of the endpoint.
(dict) –
The container for the network interface.
NetworkInterfaceId (string) –
The ID for the network interface.
VpcId (string) –
The ID of the VPC used for the endpoint.
SubnetId (string) –
The ID of the subnet used for the endpoint.
SecurityGroupId (string) –
The ID of the security group used for the endpoint.
AccessType (string) –
The type of connectivity used to access the Amazon S3 on Outposts endpoint.
CustomerOwnedIpv4Pool (string) –
The ID of the customer-owned IPv4 address pool used for the endpoint.
NextToken (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.
Exceptions
Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
Related actions include:
See also: AWS API Documentation
Request Syntax
response = client.list_shared_endpoints(
NextToken='string',
MaxResults=123,
OutpostId='string'
)
NextToken (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.
MaxResults (integer) – The maximum number of endpoints that will be returned in the response.
OutpostId (string) –
[REQUIRED]
The ID of the Amazon Web Services Outpost.
dict
Response Syntax
{
'Endpoints': [
{
'EndpointArn': 'string',
'OutpostsId': 'string',
'CidrBlock': 'string',
'Status': 'Pending'|'Available'|'Deleting',
'CreationTime': datetime(2015, 1, 1),
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string'
},
],
'VpcId': 'string',
'SubnetId': 'string',
'SecurityGroupId': 'string',
'AccessType': 'Private'|'CustomerOwnedIp',
'CustomerOwnedIpv4Pool': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
Endpoints (list) –
The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).
(dict) –
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 .
EndpointArn (string) –
The Amazon Resource Name (ARN) of the endpoint.
OutpostsId (string) –
The ID of the Outposts.
CidrBlock (string) –
The VPC CIDR committed by this endpoint.
Status (string) –
The status of the endpoint.
CreationTime (datetime) –
The time the endpoint was created.
NetworkInterfaces (list) –
The network interface of the endpoint.
(dict) –
The container for the network interface.
NetworkInterfaceId (string) –
The ID for the network interface.
VpcId (string) –
The ID of the VPC used for the endpoint.
SubnetId (string) –
The ID of the subnet used for the endpoint.
SecurityGroupId (string) –
The ID of the security group used for the endpoint.
AccessType (string) –
The type of connectivity used to access the Amazon S3 on Outposts endpoint.
CustomerOwnedIpv4Pool (string) –
The ID of the customer-owned IPv4 address pool used for the endpoint.
NextToken (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.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Access was denied for this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Access was denied for this action.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
There was a conflict with this action, and it could not be completed.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There was a conflict with this action, and it could not be completed.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
There was an exception with the internal server.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There was an exception with the internal server.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The requested resource was not found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The requested resource was not found.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
There was an exception validating this data.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There was an exception validating this data.
Message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
paginator = client.get_paginator('list_endpoints')
Creates an iterator that will paginate through responses from S3Outposts.Client.list_endpoints()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Endpoints': [
{
'EndpointArn': 'string',
'OutpostsId': 'string',
'CidrBlock': 'string',
'Status': 'Pending'|'Available'|'Deleting',
'CreationTime': datetime(2015, 1, 1),
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string'
},
],
'VpcId': 'string',
'SubnetId': 'string',
'SecurityGroupId': 'string',
'AccessType': 'Private'|'CustomerOwnedIp',
'CustomerOwnedIpv4Pool': 'string'
},
],
}
Response Structure
(dict) –
Endpoints (list) –
The list of endpoints associated with the specified Outpost.
(dict) –
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 .
EndpointArn (string) –
The Amazon Resource Name (ARN) of the endpoint.
OutpostsId (string) –
The ID of the Outposts.
CidrBlock (string) –
The VPC CIDR committed by this endpoint.
Status (string) –
The status of the endpoint.
CreationTime (datetime) –
The time the endpoint was created.
NetworkInterfaces (list) –
The network interface of the endpoint.
(dict) –
The container for the network interface.
NetworkInterfaceId (string) –
The ID for the network interface.
VpcId (string) –
The ID of the VPC used for the endpoint.
SubnetId (string) –
The ID of the subnet used for the endpoint.
SecurityGroupId (string) –
The ID of the security group used for the endpoint.
AccessType (string) –
The type of connectivity used to access the Amazon S3 on Outposts endpoint.
CustomerOwnedIpv4Pool (string) –
The ID of the customer-owned IPv4 address pool used for the endpoint.
paginator = client.get_paginator('list_shared_endpoints')
Creates an iterator that will paginate through responses from S3Outposts.Client.list_shared_endpoints()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OutpostId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
OutpostId (string) –
[REQUIRED]
The ID of the Amazon Web Services Outpost.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'Endpoints': [
{
'EndpointArn': 'string',
'OutpostsId': 'string',
'CidrBlock': 'string',
'Status': 'Pending'|'Available'|'Deleting',
'CreationTime': datetime(2015, 1, 1),
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string'
},
],
'VpcId': 'string',
'SubnetId': 'string',
'SecurityGroupId': 'string',
'AccessType': 'Private'|'CustomerOwnedIp',
'CustomerOwnedIpv4Pool': 'string'
},
],
}
Response Structure
(dict) –
Endpoints (list) –
The list of endpoints associated with the specified Outpost that have been shared by Amazon Web Services Resource Access Manager (RAM).
(dict) –
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 .
EndpointArn (string) –
The Amazon Resource Name (ARN) of the endpoint.
OutpostsId (string) –
The ID of the Outposts.
CidrBlock (string) –
The VPC CIDR committed by this endpoint.
Status (string) –
The status of the endpoint.
CreationTime (datetime) –
The time the endpoint was created.
NetworkInterfaces (list) –
The network interface of the endpoint.
(dict) –
The container for the network interface.
NetworkInterfaceId (string) –
The ID for the network interface.
VpcId (string) –
The ID of the VPC used for the endpoint.
SubnetId (string) –
The ID of the subnet used for the endpoint.
SecurityGroupId (string) –
The ID of the security group used for the endpoint.
AccessType (string) –
The type of connectivity used to access the Amazon S3 on Outposts endpoint.
CustomerOwnedIpv4Pool (string) –
The ID of the customer-owned IPv4 address pool used for the endpoint.