Packages
aws
0.12.0
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/s3_outposts.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.S3Outposts do
@moduledoc """
Amazon S3 on Outposts provides access to S3 on Outposts operations.
"""
alias AWS.Client
alias AWS.Request
def metadata do
%AWS.ServiceMetadata{
abbreviation: nil,
api_version: "2017-07-25",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "s3-outposts",
global?: false,
protocol: "rest-json",
service_id: "S3Outposts",
signature_version: "v4",
signing_name: "s3-outposts",
target_prefix: nil
}
end
@doc """
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](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html) *
[ListEndpoints](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html)
"""
def create_endpoint(%Client{} = client, input, options \\ []) do
url_path = "/S3Outposts/CreateEndpoint"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
nil
)
end
@doc """
Deletes an endpoint.
It can take up to 5 minutes for this action to finish.
Related actions include:
*
[CreateEndpoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) *
[ListEndpoints](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html)
"""
def delete_endpoint(%Client{} = client, input, options \\ []) do
url_path = "/S3Outposts/DeleteEndpoint"
headers = []
{query_params, input} =
[
{"EndpointId", "endpointId"},
{"OutpostId", "outpostId"}
]
|> Request.build_params(input)
Request.request_rest(
client,
metadata(),
:delete,
url_path,
query_params,
headers,
input,
options,
nil
)
end
@doc """
Lists endpoints associated with the specified Outpost.
Related actions include:
*
[CreateEndpoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) *
[DeleteEndpoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html)
"""
def list_endpoints(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/S3Outposts/ListEndpoints"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
nil
)
end
@doc """
Lists all endpoints associated with an Outpost that has been shared by Amazon
Web Services Resource Access Manager (RAM).
Related actions include:
*
[CreateEndpoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html) *
[DeleteEndpoint](https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html)
"""
def list_shared_endpoints(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
outpost_id,
options \\ []
) do
url_path = "/S3Outposts/ListSharedEndpoints"
headers = []
query_params = []
query_params =
if !is_nil(outpost_id) do
[{"outpostId", outpost_id} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
nil
)
end
end