...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/s3outposts"
Overview
Constants

Overview ▾

Package s3outposts provides the client and types for making API requests to Amazon S3 on Outposts.

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

See https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25 for more information on this service.

See s3outposts package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/s3outposts/

Using the Client

To contact Amazon S3 on Outposts with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon S3 on Outposts client S3Outposts for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/s3outposts/#New

The stub package, s3outpostsiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type S3Outposts
func New(p client.ConfigProvider, cfgs ...*aws.Config) *S3Outposts
func (c *S3Outposts) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error)
func (c *S3Outposts) CreateEndpointRequest(input *CreateEndpointInput) (req *request.Request, output *CreateEndpointOutput)
func (c *S3Outposts) CreateEndpointWithContext(ctx aws.Context, input *CreateEndpointInput, opts ...request.Option) (*CreateEndpointOutput, error)
func (c *S3Outposts) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
func (c *S3Outposts) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)
func (c *S3Outposts) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)
func (c *S3Outposts) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)
func (c *S3Outposts) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error
func (c *S3Outposts) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) error
func (c *S3Outposts) ListEndpointsRequest(input *ListEndpointsInput) (req *request.Request, output *ListEndpointsOutput)
func (c *S3Outposts) ListEndpointsWithContext(ctx aws.Context, input *ListEndpointsInput, opts ...request.Option) (*ListEndpointsOutput, error)
func EndpointAccessType_Values() []string
func EndpointStatus_Values() []string
type AccessDeniedException
type ConflictException
type CreateEndpointInput
type CreateEndpointOutput
type DeleteEndpointInput
type DeleteEndpointOutput
type Endpoint
type InternalServerException
type ListEndpointsInput
type ListEndpointsOutput
type NetworkInterface
type ResourceNotFoundException
type ValidationException

Constants ▾

const (
    // EndpointAccessTypePrivate is a EndpointAccessType enum value
    EndpointAccessTypePrivate = "Private"

    // EndpointAccessTypeCustomerOwnedIp is a EndpointAccessType enum value
    EndpointAccessTypeCustomerOwnedIp = "CustomerOwnedIp"
)
const (
    // EndpointStatusPending is a EndpointStatus enum value
    EndpointStatusPending = "Pending"

    // EndpointStatusAvailable is a EndpointStatus enum value
    EndpointStatusAvailable = "Available"

    // EndpointStatusDeleting is a EndpointStatus enum value
    EndpointStatusDeleting = "Deleting"
)
const (

    // ErrCodeAccessDeniedException for service response error code
    // "AccessDeniedException".
    //
    // Access was denied for this action.
    ErrCodeAccessDeniedException = "AccessDeniedException"

    // ErrCodeConflictException for service response error code
    // "ConflictException".
    //
    // There was a conflict with this action, and it could not be completed.
    ErrCodeConflictException = "ConflictException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // There was an exception with the internal server.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // The requested resource was not found.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeValidationException for service response error code
    // "ValidationException".
    //
    // There was an exception validating this data.
    ErrCodeValidationException = "ValidationException"
)
const (
    ServiceName = "S3Outposts"  // Name of service.
    EndpointsID = "s3-outposts" // ID to lookup a service endpoint with.
    ServiceID   = "S3Outposts"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

func EndpointAccessType_Values

func EndpointAccessType_Values() []string

EndpointAccessType_Values returns all elements of the EndpointAccessType enum

func EndpointStatus_Values

func EndpointStatus_Values() []string

EndpointStatus_Values returns all elements of the EndpointStatus enum

type AccessDeniedException

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

Access was denied for this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

There was a conflict with this action, and it could not be completed.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEndpointInput

type CreateEndpointInput struct {

    // The type of access for the on-premise network connectivity for the Outpost
    // endpoint. To access the endpoint from an on-premises network, you must specify
    // the access type and provide the customer owned IPv4 pool.
    AccessType *string `type:"string" enum:"EndpointAccessType"`

    // The ID of the customer-owned IPv4 pool for the endpoint. IP addresses will
    // be allocated from this pool for the endpoint.
    CustomerOwnedIpv4Pool *string `type:"string"`

    // The ID of the AWS Outposts.
    //
    // OutpostId is a required field
    OutpostId *string `type:"string" required:"true"`

    // The ID of the security group to use with the endpoint.
    //
    // SecurityGroupId is a required field
    SecurityGroupId *string `type:"string" required:"true"`

    // The ID of the subnet in the selected VPC. The endpoint subnet must belong
    // to the Outpost that has the Amazon S3 on Outposts provisioned.
    //
    // SubnetId is a required field
    SubnetId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateEndpointInput) GoString

func (s CreateEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointInput) SetAccessType

func (s *CreateEndpointInput) SetAccessType(v string) *CreateEndpointInput

SetAccessType sets the AccessType field's value.

func (*CreateEndpointInput) SetCustomerOwnedIpv4Pool

func (s *CreateEndpointInput) SetCustomerOwnedIpv4Pool(v string) *CreateEndpointInput

SetCustomerOwnedIpv4Pool sets the CustomerOwnedIpv4Pool field's value.

func (*CreateEndpointInput) SetOutpostId

func (s *CreateEndpointInput) SetOutpostId(v string) *CreateEndpointInput

SetOutpostId sets the OutpostId field's value.

func (*CreateEndpointInput) SetSecurityGroupId

func (s *CreateEndpointInput) SetSecurityGroupId(v string) *CreateEndpointInput

SetSecurityGroupId sets the SecurityGroupId field's value.

func (*CreateEndpointInput) SetSubnetId

func (s *CreateEndpointInput) SetSubnetId(v string) *CreateEndpointInput

SetSubnetId sets the SubnetId field's value.

func (CreateEndpointInput) String

func (s CreateEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointInput) Validate

func (s *CreateEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEndpointOutput

type CreateEndpointOutput struct {

    // The Amazon Resource Name (ARN) of the endpoint.
    EndpointArn *string `type:"string"`
    // contains filtered or unexported fields
}

func (CreateEndpointOutput) GoString

func (s CreateEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEndpointOutput) SetEndpointArn

func (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput

SetEndpointArn sets the EndpointArn field's value.

func (CreateEndpointOutput) String

func (s CreateEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEndpointInput

type DeleteEndpointInput struct {

    // The ID of the endpoint.
    //
    // EndpointId is a required field
    EndpointId *string `location:"querystring" locationName:"endpointId" type:"string" required:"true"`

    // The ID of the AWS Outposts.
    //
    // OutpostId is a required field
    OutpostId *string `location:"querystring" locationName:"outpostId" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteEndpointInput) GoString

func (s DeleteEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEndpointInput) SetEndpointId

func (s *DeleteEndpointInput) SetEndpointId(v string) *DeleteEndpointInput

SetEndpointId sets the EndpointId field's value.

func (*DeleteEndpointInput) SetOutpostId

func (s *DeleteEndpointInput) SetOutpostId(v string) *DeleteEndpointInput

SetOutpostId sets the OutpostId field's value.

func (DeleteEndpointInput) String

func (s DeleteEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEndpointInput) Validate

func (s *DeleteEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEndpointOutput

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

func (DeleteEndpointOutput) GoString

func (s DeleteEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEndpointOutput) String

func (s DeleteEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Endpoint

type Endpoint struct {
    AccessType *string `type:"string" enum:"EndpointAccessType"`

    // The VPC CIDR committed by this endpoint.
    CidrBlock *string `type:"string"`

    // The time the endpoint was created.
    CreationTime *time.Time `type:"timestamp"`

    // The ID of the customer-owned IPv4 pool used for the endpoint.
    CustomerOwnedIpv4Pool *string `type:"string"`

    // The Amazon Resource Name (ARN) of the endpoint.
    EndpointArn *string `type:"string"`

    // The network interface of the endpoint.
    NetworkInterfaces []*NetworkInterface `type:"list"`

    // The ID of the AWS Outposts.
    OutpostsId *string `type:"string"`

    // The ID of the security group used for the endpoint.
    SecurityGroupId *string `type:"string"`

    // The status of the endpoint.
    Status *string `type:"string" enum:"EndpointStatus"`

    // The ID of the subnet used for the endpoint.
    SubnetId *string `type:"string"`

    // The ID of the VPC used for the endpoint.
    VpcId *string `type:"string"`
    // contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html).

func (Endpoint) GoString

func (s Endpoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Endpoint) SetAccessType

func (s *Endpoint) SetAccessType(v string) *Endpoint

SetAccessType sets the AccessType field's value.

func (*Endpoint) SetCidrBlock

func (s *Endpoint) SetCidrBlock(v string) *Endpoint

SetCidrBlock sets the CidrBlock field's value.

func (*Endpoint) SetCreationTime

func (s *Endpoint) SetCreationTime(v time.Time) *Endpoint

SetCreationTime sets the CreationTime field's value.

func (*Endpoint) SetCustomerOwnedIpv4Pool

func (s *Endpoint) SetCustomerOwnedIpv4Pool(v string) *Endpoint

SetCustomerOwnedIpv4Pool sets the CustomerOwnedIpv4Pool field's value.

func (*Endpoint) SetEndpointArn

func (s *Endpoint) SetEndpointArn(v string) *Endpoint

SetEndpointArn sets the EndpointArn field's value.

func (*Endpoint) SetNetworkInterfaces

func (s *Endpoint) SetNetworkInterfaces(v []*NetworkInterface) *Endpoint

SetNetworkInterfaces sets the NetworkInterfaces field's value.

func (*Endpoint) SetOutpostsId

func (s *Endpoint) SetOutpostsId(v string) *Endpoint

SetOutpostsId sets the OutpostsId field's value.

func (*Endpoint) SetSecurityGroupId

func (s *Endpoint) SetSecurityGroupId(v string) *Endpoint

SetSecurityGroupId sets the SecurityGroupId field's value.

func (*Endpoint) SetStatus

func (s *Endpoint) SetStatus(v string) *Endpoint

SetStatus sets the Status field's value.

func (*Endpoint) SetSubnetId

func (s *Endpoint) SetSubnetId(v string) *Endpoint

SetSubnetId sets the SubnetId field's value.

func (*Endpoint) SetVpcId

func (s *Endpoint) SetVpcId(v string) *Endpoint

SetVpcId sets the VpcId field's value.

func (Endpoint) String

func (s Endpoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

There was an exception with the internal server.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEndpointsInput

type ListEndpointsInput struct {

    // The max number of endpoints that can be returned on the request.
    MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

    // The next endpoint requested in the list.
    NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListEndpointsInput) GoString

func (s ListEndpointsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEndpointsInput) SetMaxResults

func (s *ListEndpointsInput) SetMaxResults(v int64) *ListEndpointsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEndpointsInput) SetNextToken

func (s *ListEndpointsInput) SetNextToken(v string) *ListEndpointsInput

SetNextToken sets the NextToken field's value.

func (ListEndpointsInput) String

func (s ListEndpointsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEndpointsInput) Validate

func (s *ListEndpointsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEndpointsOutput

type ListEndpointsOutput struct {

    // Returns an array of endpoints associated with AWS Outposts.
    Endpoints []*Endpoint `type:"list"`

    // The next endpoint returned in the list.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListEndpointsOutput) GoString

func (s ListEndpointsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEndpointsOutput) SetEndpoints

func (s *ListEndpointsOutput) SetEndpoints(v []*Endpoint) *ListEndpointsOutput

SetEndpoints sets the Endpoints field's value.

func (*ListEndpointsOutput) SetNextToken

func (s *ListEndpointsOutput) SetNextToken(v string) *ListEndpointsOutput

SetNextToken sets the NextToken field's value.

func (ListEndpointsOutput) String

func (s ListEndpointsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkInterface

type NetworkInterface struct {

    // The ID for the network interface.
    NetworkInterfaceId *string `type:"string"`
    // contains filtered or unexported fields
}

The container for the network interface.

func (NetworkInterface) GoString

func (s NetworkInterface) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkInterface) SetNetworkInterfaceId

func (s *NetworkInterface) SetNetworkInterfaceId(v string) *NetworkInterface

SetNetworkInterfaceId sets the NetworkInterfaceId field's value.

func (NetworkInterface) String

func (s NetworkInterface) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

The requested resource was not found.

func (*ResourceNotFoundException) Code

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Outposts

type S3Outposts struct {
    *client.Client
}

S3Outposts provides the API operation methods for making requests to Amazon S3 on Outposts. See this package's package overview docs for details on the service.

S3Outposts methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *S3Outposts

New creates a new instance of the S3Outposts client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a S3Outposts client from just a session.
svc := s3outposts.New(mySession)

// Create a S3Outposts client with additional configuration
svc := s3outposts.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*S3Outposts) CreateEndpoint

func (c *S3Outposts) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error)

CreateEndpoint API operation for Amazon S3 on Outposts.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html).

This action creates an endpoint and associates it with the specified Outposts.

It can take up to 5 minutes for this action to complete.

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)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon S3 on Outposts's API operation CreateEndpoint for usage and error information.

Returned Error Types:

* InternalServerException
There was an exception with the internal server.

* ValidationException
There was an exception validating this data.

* AccessDeniedException
Access was denied for this action.

* ResourceNotFoundException
The requested resource was not found.

* ConflictException
There was a conflict with this action, and it could not be completed.

See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/CreateEndpoint

func (*S3Outposts) CreateEndpointRequest

func (c *S3Outposts) CreateEndpointRequest(input *CreateEndpointInput) (req *request.Request, output *CreateEndpointOutput)

CreateEndpointRequest generates a "aws/request.Request" representing the client's request for the CreateEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEndpoint for more information on using the CreateEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEndpointRequest method.
req, resp := client.CreateEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/CreateEndpoint

func (*S3Outposts) CreateEndpointWithContext

func (c *S3Outposts) CreateEndpointWithContext(ctx aws.Context, input *CreateEndpointInput, opts ...request.Option) (*CreateEndpointOutput, error)

CreateEndpointWithContext is the same as CreateEndpoint with the addition of the ability to pass a context and additional request options.

See CreateEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Outposts) DeleteEndpoint

func (c *S3Outposts) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)

DeleteEndpoint API operation for Amazon S3 on Outposts.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html).

This action deletes an endpoint.

It can take up to 5 minutes for this action to complete.

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)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon S3 on Outposts's API operation DeleteEndpoint for usage and error information.

Returned Error Types:

* InternalServerException
There was an exception with the internal server.

* AccessDeniedException
Access was denied for this action.

* ResourceNotFoundException
The requested resource was not found.

* ValidationException
There was an exception validating this data.

See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/DeleteEndpoint

func (*S3Outposts) DeleteEndpointRequest

func (c *S3Outposts) DeleteEndpointRequest(input *DeleteEndpointInput) (req *request.Request, output *DeleteEndpointOutput)

DeleteEndpointRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEndpoint for more information on using the DeleteEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEndpointRequest method.
req, resp := client.DeleteEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/DeleteEndpoint

func (*S3Outposts) DeleteEndpointWithContext

func (c *S3Outposts) DeleteEndpointWithContext(ctx aws.Context, input *DeleteEndpointInput, opts ...request.Option) (*DeleteEndpointOutput, error)

DeleteEndpointWithContext is the same as DeleteEndpoint with the addition of the ability to pass a context and additional request options.

See DeleteEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Outposts) ListEndpoints

func (c *S3Outposts) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)

ListEndpoints API operation for Amazon S3 on Outposts.

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/AccessingS3Outposts.html).

This action lists endpoints associated with the Outposts.

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)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon S3 on Outposts's API operation ListEndpoints for usage and error information.

Returned Error Types:

* InternalServerException
There was an exception with the internal server.

* ResourceNotFoundException
The requested resource was not found.

* AccessDeniedException
Access was denied for this action.

* ValidationException
There was an exception validating this data.

See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListEndpoints

func (*S3Outposts) ListEndpointsPages

func (c *S3Outposts) ListEndpointsPages(input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool) error

ListEndpointsPages iterates over the pages of a ListEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListEndpoints method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListEndpoints operation.
pageNum := 0
err := client.ListEndpointsPages(params,
    func(page *s3outposts.ListEndpointsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*S3Outposts) ListEndpointsPagesWithContext

func (c *S3Outposts) ListEndpointsPagesWithContext(ctx aws.Context, input *ListEndpointsInput, fn func(*ListEndpointsOutput, bool) bool, opts ...request.Option) error

ListEndpointsPagesWithContext same as ListEndpointsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*S3Outposts) ListEndpointsRequest

func (c *S3Outposts) ListEndpointsRequest(input *ListEndpointsInput) (req *request.Request, output *ListEndpointsOutput)

ListEndpointsRequest generates a "aws/request.Request" representing the client's request for the ListEndpoints operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEndpoints for more information on using the ListEndpoints API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEndpointsRequest method.
req, resp := client.ListEndpointsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListEndpoints

func (*S3Outposts) ListEndpointsWithContext

func (c *S3Outposts) ListEndpointsWithContext(ctx aws.Context, input *ListEndpointsInput, opts ...request.Option) (*ListEndpointsOutput, error)

ListEndpointsWithContext is the same as ListEndpoints with the addition of the ability to pass a context and additional request options.

See ListEndpoints for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ValidationException

type ValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

There was an exception validating this data.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".