S3Outposts

This page documents function available when using the S3Outposts module, created with @service S3Outposts.

Index

Documentation

Main.S3Outposts.create_endpointMethod
create_endpoint(outpost_id, security_group_id, subnet_id)
create_endpoint(outpost_id, security_group_id, subnet_id, params::Dict{String,<:Any})

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: DeleteEndpoint ListEndpoints

Arguments

  • outpost_id: The ID of the Outposts.
  • security_group_id: The ID of the security group to use with the endpoint.
  • subnet_id: The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccessType": 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": The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.
source
Main.S3Outposts.delete_endpointMethod
delete_endpoint(endpoint_id, outpost_id)
delete_endpoint(endpoint_id, outpost_id, params::Dict{String,<:Any})

Deletes an endpoint. It can take up to 5 minutes for this action to finish. Related actions include: CreateEndpoint ListEndpoints

Arguments

  • endpoint_id: The ID of the endpoint.
  • outpost_id: The ID of the Outposts.
source
Main.S3Outposts.list_endpointsMethod
list_endpoints()
list_endpoints(params::Dict{String,<:Any})

Lists endpoints associated with the specified Outpost. Related actions include: CreateEndpoint DeleteEndpoint

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of endpoints that will be returned in the response.
  • "nextToken": If a previous response from this operation included a NextToken value, provide that value here to retrieve the next page of results.
source
Main.S3Outposts.list_outposts_with_s3Method
list_outposts_with_s3()
list_outposts_with_s3(params::Dict{String,<:Any})

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).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of Outposts to return. The limit is 100.
  • "nextToken": 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.
source
Main.S3Outposts.list_shared_endpointsMethod
list_shared_endpoints(outpost_id)
list_shared_endpoints(outpost_id, params::Dict{String,<:Any})

Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM). Related actions include: CreateEndpoint DeleteEndpoint

Arguments

  • outpost_id: The ID of the Amazon Web Services Outpost.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of endpoints that will be returned in the response.
  • "nextToken": If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.
source