Documentation

Overview

    Package s3outposts provides the API client, operations, and parameter types for Amazon S3 on Outposts.

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

    Index

    Constants

    View Source 
    const ServiceAPIVersion = "2017-07-25"
    View Source 
    const ServiceID = "S3Outposts"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver 

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions 

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver 

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client 

          type Client struct {
	// contains filtered or unexported fields
}

            Client provides the API client to make operations call for Amazon S3 on Outposts.

            func New 

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig 

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CreateEndpoint 

                func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error)

                  S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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). This action creates an endpoint and associates it with the specified Outpost. 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)

                  func (*Client) DeleteEndpoint 

                  func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error)

                    S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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). This action deletes an endpoint. 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)

                    func (*Client) ListEndpoints 

                    func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error)

                      S3 on Outposts access points simplify managing data access at scale for shared datasets in Amazon 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). This action lists endpoints associated with the 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)

                      type CreateEndpointInput 

                      type CreateEndpointInput struct {

	// The ID of the AWS Outpost.
	//
	// This member is required.
	OutpostId *string

	// The ID of the security group to use with the endpoint.
	//
	// This member is required.
	SecurityGroupId *string

	// The ID of the subnet in the selected VPC.
	//
	// This member is required.
	SubnetId *string
}

                      type CreateEndpointOutput 

                      type CreateEndpointOutput struct {

	// The Amazon Resource Name (ARN) of the endpoint.
	EndpointArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                      type DeleteEndpointInput 

                      type DeleteEndpointInput struct {

	// The ID of the end point.
	//
	// This member is required.
	EndpointId *string

	// The ID of the AWS Outpost.
	//
	// This member is required.
	OutpostId *string
}

                      type DeleteEndpointOutput 

                      type DeleteEndpointOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                      type EndpointResolver 

                      type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

                        EndpointResolver interface for resolving service endpoints.

                        func EndpointResolverFromURL 

                        func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                          EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                          type EndpointResolverFunc 

                          type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                            EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                            func (EndpointResolverFunc) ResolveEndpoint 

                            func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                            type EndpointResolverOptions 

                            type EndpointResolverOptions = internalendpoints.Options

                              EndpointResolverOptions is the service endpoint resolver options

                              type HTTPClient 

                              type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

                              type HTTPSignerV4 

                              type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

                              type ListEndpointsAPIClient 

                              type ListEndpointsAPIClient interface {
	ListEndpoints(context.Context, *ListEndpointsInput, ...func(*Options)) (*ListEndpointsOutput, error)
}

                                ListEndpointsAPIClient is a client that implements the ListEndpoints operation.

                                type ListEndpointsInput 

                                type ListEndpointsInput struct {

	// The max number of endpoints that can be returned on the request.
	MaxResults int32

	// The next endpoint requested in the list.
	NextToken *string
}

                                type ListEndpointsOutput 

                                type ListEndpointsOutput struct {

	// Returns an array of endpoints associated with AWS Outpost.
	Endpoints []types.Endpoint

	// The next endpoint returned in the list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

                                type ListEndpointsPaginator 

                                type ListEndpointsPaginator struct {
	// contains filtered or unexported fields
}

                                  ListEndpointsPaginator is a paginator for ListEndpoints

                                  func NewListEndpointsPaginator 

                                  func NewListEndpointsPaginator(client ListEndpointsAPIClient, params *ListEndpointsInput, optFns ...func(*ListEndpointsPaginatorOptions)) *ListEndpointsPaginator

                                    NewListEndpointsPaginator returns a new ListEndpointsPaginator

                                    func (*ListEndpointsPaginator) HasMorePages 

                                    func (p *ListEndpointsPaginator) HasMorePages() bool

                                      HasMorePages returns a boolean indicating whether more pages are available

                                      func (*ListEndpointsPaginator) NextPage 

                                      func (p *ListEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEndpointsOutput, error)

                                        NextPage retrieves the next ListEndpoints page.

                                        type ListEndpointsPaginatorOptions 

                                        type ListEndpointsPaginatorOptions struct {
	// The max number of endpoints that can be returned on the request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

                                          ListEndpointsPaginatorOptions is the paginator options for ListEndpoints

                                          type Options 

                                          type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

                                          func (Options) Copy 

                                          func (o Options) Copy() Options

                                            Copy creates a clone where the APIOptions list is deep copied.

                                            type ResolveEndpoint 

                                            type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

                                            func (*ResolveEndpoint) HandleSerialize 

                                            func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

                                            func (*ResolveEndpoint) ID 

                                            func (*ResolveEndpoint) ID() string

                                            Source Files

                                            View all

                                            Directories

                                            Path Synopsis
                                            internal
                                            endpoints