S3Outposts

Service object for interacting with AWS S3Outposts service.

public struct S3Outposts: AWSService 

Amazon S3 on Outposts provides access to S3 on Outposts operations.

Inheritance

AWSService

Initializers

init(client:region:partition:endpoint:timeout:byteBufferAllocator:options:)

Initialize the S3Outposts client

public init(
        client: AWSClient,
        region: SotoCore.Region? = nil,
        partition: AWSPartition = .aws,
        endpoint: String? = nil,
        timeout: TimeAmount? = nil,
        byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(),
        options: AWSServiceConfig.Options = []
    ) 

Parameters

• client: AWSClient used to process requests
• region: Region of server you want to communicate with. This will override the partition parameter.
• partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
• endpoint: Custom endpoint URL to use instead of standard AWS servers
• timeout: Timeout value for HTTP requests

init(from:patch:)

Initializer required by AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options). You are not able to use this initializer directly as there are no public initializers for AWSServiceConfig.Patch. Please use AWSService.with(middlewares:​timeout:​byteBufferAllocator:​options) instead.

public init(from: S3Outposts, patch: AWSServiceConfig.Patch) 

Properties

client

Client used for communication with AWS

public let client: AWSClient

config

Service configuration

public let config: AWSServiceConfig

Methods

createEndpoint(_:logger:on:)

public func createEndpoint(_ input: CreateEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<CreateEndpointResult> 

Creates an endpoint and associates it with the specified Outpost.

Related actions include:

• DeleteEndpoint

• ListEndpoints

deleteEndpoint(_:logger:on:)

@discardableResult public func deleteEndpoint(_ input: DeleteEndpointRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<Void> 

Deletes an endpoint.

Related actions include:

• CreateEndpoint

• ListEndpoints

listEndpoints(_:logger:on:)

public func listEndpoints(_ input: ListEndpointsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListEndpointsResult> 

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

listSharedEndpoints(_:logger:on:)

public func listSharedEndpoints(_ input: ListSharedEndpointsRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListSharedEndpointsResult> 

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

listEndpointsPaginator(_:logger:on:)

compiler(>=5.5.2) && canImport(_Concurrency)

public func listEndpointsPaginator(
        _ input: ListEndpointsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<ListEndpointsRequest, ListEndpointsResult> 

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

listSharedEndpointsPaginator(_:logger:on:)

compiler(>=5.5.2) && canImport(_Concurrency)

public func listSharedEndpointsPaginator(
        _ input: ListSharedEndpointsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil
    ) -> AWSClient.PaginatorSequence<ListSharedEndpointsRequest, ListSharedEndpointsResult> 

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Return PaginatorSequence for operation. - Parameters: - input: Input for request - logger: Logger used flot logging - eventLoop: EventLoop to run this process on

listEndpointsPaginator(_:_:logger:on:onPage:)

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:​_:​) -> Result.

public func listEndpointsPaginator<Result>(
        _ input: ListEndpointsRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, ListEndpointsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result> 

Lists endpoints associated with the specified Outpost.

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Parameters:

• input: Input for request

• initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

• logger: Logger used flot logging

• eventLoop: EventLoop to run this process on

• onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

listEndpointsPaginator(_:logger:on:onPage:)

Provide paginated results to closure onPage.

public func listEndpointsPaginator(
        _ input: ListEndpointsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (ListEndpointsResult, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void> 

Parameters

• input: Input for request
• logger: Logger used flot logging
• eventLoop: EventLoop to run this process on
• onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.

listSharedEndpointsPaginator(_:_:logger:on:onPage:)

Provide paginated results to closure onPage for it to combine them into one result. This works in a similar manner to Array.reduce<Result>(_:​_:​) -> Result.

public func listSharedEndpointsPaginator<Result>(
        _ input: ListSharedEndpointsRequest,
        _ initialValue: Result,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (Result, ListSharedEndpointsResult, EventLoop) -> EventLoopFuture<(Bool, Result)>
    ) -> EventLoopFuture<Result> 

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

Related actions include:

• CreateEndpoint

• DeleteEndpoint

Parameters:

• input: Input for request

• initialValue: The value to use as the initial accumulating value. initialValue is passed to onPage the first time it is called.

• logger: Logger used flot logging

• eventLoop: EventLoop to run this process on

• onPage: closure called with each paginated response. It combines an accumulating result with the contents of response. This combined result is then returned along with a boolean indicating if the paginate operation should continue.

listSharedEndpointsPaginator(_:logger:on:onPage:)

Provide paginated results to closure onPage.

public func listSharedEndpointsPaginator(
        _ input: ListSharedEndpointsRequest,
        logger: Logger = AWSClient.loggingDisabled,
        on eventLoop: EventLoop? = nil,
        onPage: @escaping (ListSharedEndpointsResult, EventLoop) -> EventLoopFuture<Bool>
    ) -> EventLoopFuture<Void> 

Parameters

• input: Input for request
• logger: Logger used flot logging
• eventLoop: EventLoop to run this process on
• onPage: closure called with each block of entries. Returns boolean indicating whether we should continue.