func EndpointAccessType_Values() []string
EndpointAccessType_Values returns all elements of the EndpointAccessType enum
func EndpointStatus_Values() []string
EndpointStatus_Values returns all elements of the EndpointStatus enum
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 (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
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 (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
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 (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 struct {
// 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.
AccessType *string `type:"string" enum:"EndpointAccessType"`
// The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint.
// IP addresses are allocated from this pool for the endpoint.
CustomerOwnedIpv4Pool *string `type:"string"`
// The ID of the 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 Amazon S3 on Outposts provisioned.
//
// SubnetId is a required field
SubnetId *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
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 (s *CreateEndpointInput) SetAccessType(v string) *CreateEndpointInput
SetAccessType sets the AccessType field's value.
func (s *CreateEndpointInput) SetCustomerOwnedIpv4Pool(v string) *CreateEndpointInput
SetCustomerOwnedIpv4Pool sets the CustomerOwnedIpv4Pool field's value.
func (s *CreateEndpointInput) SetOutpostId(v string) *CreateEndpointInput
SetOutpostId sets the OutpostId field's value.
func (s *CreateEndpointInput) SetSecurityGroupId(v string) *CreateEndpointInput
SetSecurityGroupId sets the SecurityGroupId field's value.
func (s *CreateEndpointInput) SetSubnetId(v string) *CreateEndpointInput
SetSubnetId sets the SubnetId field's value.
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 (s *CreateEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateEndpointOutput struct {
// The Amazon Resource Name (ARN) of the endpoint.
EndpointArn *string `type:"string"`
// contains filtered or unexported fields
}
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 (s *CreateEndpointOutput) SetEndpointArn(v string) *CreateEndpointOutput
SetEndpointArn sets the EndpointArn field's value.
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 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 Outposts.
//
// OutpostId is a required field
OutpostId *string `location:"querystring" locationName:"outpostId" type:"string" required:"true"`
// contains filtered or unexported fields
}
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 (s *DeleteEndpointInput) SetEndpointId(v string) *DeleteEndpointInput
SetEndpointId sets the EndpointId field's value.
func (s *DeleteEndpointInput) SetOutpostId(v string) *DeleteEndpointInput
SetOutpostId sets the OutpostId field's value.
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 (s *DeleteEndpointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteEndpointOutput struct {
// contains filtered or unexported fields
}
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 (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 struct {
// The type of connectivity used to access the Amazon S3 on Outposts endpoint.
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 address pool used for the endpoint.
CustomerOwnedIpv4Pool *string `type:"string"`
// The Amazon Resource Name (ARN) of the endpoint.
EndpointArn *string `type:"string"`
// The failure reason, if any, for a create or delete endpoint operation.
FailedReason *FailedReason `type:"structure"`
// The network interface of the endpoint.
NetworkInterfaces []*NetworkInterface `type:"list"`
// The ID of the 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/WorkingWithS3Outposts.html) in the Amazon Simple Storage Service User Guide.
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 (s *Endpoint) SetAccessType(v string) *Endpoint
SetAccessType sets the AccessType field's value.
func (s *Endpoint) SetCidrBlock(v string) *Endpoint
SetCidrBlock sets the CidrBlock field's value.
func (s *Endpoint) SetCreationTime(v time.Time) *Endpoint
SetCreationTime sets the CreationTime field's value.
func (s *Endpoint) SetCustomerOwnedIpv4Pool(v string) *Endpoint
SetCustomerOwnedIpv4Pool sets the CustomerOwnedIpv4Pool field's value.
func (s *Endpoint) SetEndpointArn(v string) *Endpoint
SetEndpointArn sets the EndpointArn field's value.
func (s *Endpoint) SetFailedReason(v *FailedReason) *Endpoint
SetFailedReason sets the FailedReason field's value.
func (s *Endpoint) SetNetworkInterfaces(v []*NetworkInterface) *Endpoint
SetNetworkInterfaces sets the NetworkInterfaces field's value.
func (s *Endpoint) SetOutpostsId(v string) *Endpoint
SetOutpostsId sets the OutpostsId field's value.
func (s *Endpoint) SetSecurityGroupId(v string) *Endpoint
SetSecurityGroupId sets the SecurityGroupId field's value.
func (s *Endpoint) SetStatus(v string) *Endpoint
SetStatus sets the Status field's value.
func (s *Endpoint) SetSubnetId(v string) *Endpoint
SetSubnetId sets the SubnetId field's value.
func (s *Endpoint) SetVpcId(v string) *Endpoint
SetVpcId sets the VpcId field's value.
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 FailedReason struct {
// The failure code, if any, for a create or delete endpoint operation.
ErrorCode *string `type:"string"`
// Additional error details describing the endpoint failure and recommended
// action.
Message *string `type:"string"`
// contains filtered or unexported fields
}
The failure reason, if any, for a create or delete endpoint operation.
func (s FailedReason) 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 (s *FailedReason) SetErrorCode(v string) *FailedReason
SetErrorCode sets the ErrorCode field's value.
func (s *FailedReason) SetMessage(v string) *FailedReason
SetMessage sets the Message field's value.
func (s FailedReason) 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 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 (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
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 (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 struct {
// The maximum number of endpoints that will be returned in the response.
MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
// If a previous response from this operation included a NextToken value, provide
// that value here to retrieve the next page of results.
NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
// contains filtered or unexported fields
}
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 (s *ListEndpointsInput) SetMaxResults(v int64) *ListEndpointsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListEndpointsInput) SetNextToken(v string) *ListEndpointsInput
SetNextToken sets the NextToken field's value.
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 (s *ListEndpointsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListEndpointsOutput struct {
// The list of endpoints associated with the specified Outpost.
Endpoints []*Endpoint `type:"list"`
// If the number of endpoints associated with the specified Outpost exceeds
// MaxResults, you can include this value in subsequent calls to this operation
// to retrieve more results.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
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 (s *ListEndpointsOutput) SetEndpoints(v []*Endpoint) *ListEndpointsOutput
SetEndpoints sets the Endpoints field's value.
func (s *ListEndpointsOutput) SetNextToken(v string) *ListEndpointsOutput
SetNextToken sets the NextToken field's value.
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 ListOutpostsWithS3Input struct {
// The maximum number of Outposts to return. The limit is 100.
MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
// 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.
NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListOutpostsWithS3Input) 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 (s *ListOutpostsWithS3Input) SetMaxResults(v int64) *ListOutpostsWithS3Input
SetMaxResults sets the MaxResults field's value.
func (s *ListOutpostsWithS3Input) SetNextToken(v string) *ListOutpostsWithS3Input
SetNextToken sets the NextToken field's value.
func (s ListOutpostsWithS3Input) 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 (s *ListOutpostsWithS3Input) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListOutpostsWithS3Output struct {
// Returns a token that you can use to call ListOutpostsWithS3 again and receive
// additional results, if there are any.
NextToken *string `min:"1" type:"string"`
// Returns the list of Outposts that have the following characteristics:
//
// * outposts that have S3 provisioned
//
// * outposts that are Active (not pending any provisioning nor decommissioned)
//
// * outposts to which the the calling Amazon Web Services account has access
Outposts []*Outpost `type:"list"`
// contains filtered or unexported fields
}
func (s ListOutpostsWithS3Output) 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 (s *ListOutpostsWithS3Output) SetNextToken(v string) *ListOutpostsWithS3Output
SetNextToken sets the NextToken field's value.
func (s *ListOutpostsWithS3Output) SetOutposts(v []*Outpost) *ListOutpostsWithS3Output
SetOutposts sets the Outposts field's value.
func (s ListOutpostsWithS3Output) 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 ListSharedEndpointsInput struct {
// The maximum number of endpoints that will be returned in the response.
MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
// If a previous response from this operation included a NextToken value, you
// can provide that value here to retrieve the next page of results.
NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
// The ID of the Amazon Web Services Outpost.
//
// OutpostId is a required field
OutpostId *string `location:"querystring" locationName:"outpostId" type:"string" required:"true"`
// contains filtered or unexported fields
}
func (s ListSharedEndpointsInput) 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 (s *ListSharedEndpointsInput) SetMaxResults(v int64) *ListSharedEndpointsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListSharedEndpointsInput) SetNextToken(v string) *ListSharedEndpointsInput
SetNextToken sets the NextToken field's value.
func (s *ListSharedEndpointsInput) SetOutpostId(v string) *ListSharedEndpointsInput
SetOutpostId sets the OutpostId field's value.
func (s ListSharedEndpointsInput) 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 (s *ListSharedEndpointsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListSharedEndpointsOutput struct {
// The list of endpoints associated with the specified Outpost that have been
// shared by Amazon Web Services Resource Access Manager (RAM).
Endpoints []*Endpoint `type:"list"`
// If the number of endpoints associated with the specified Outpost exceeds
// MaxResults, you can include this value in subsequent calls to this operation
// to retrieve more results.
NextToken *string `min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s ListSharedEndpointsOutput) 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 (s *ListSharedEndpointsOutput) SetEndpoints(v []*Endpoint) *ListSharedEndpointsOutput
SetEndpoints sets the Endpoints field's value.
func (s *ListSharedEndpointsOutput) SetNextToken(v string) *ListSharedEndpointsOutput
SetNextToken sets the NextToken field's value.
func (s ListSharedEndpointsOutput) 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 struct {
// The ID for the network interface.
NetworkInterfaceId *string `type:"string"`
// contains filtered or unexported fields
}
The container for the network interface.
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 (s *NetworkInterface) SetNetworkInterfaceId(v string) *NetworkInterface
SetNetworkInterfaceId sets the NetworkInterfaceId field's value.
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 Outpost struct {
// The Amazon S3 capacity of the outpost in bytes.
CapacityInBytes *int64 `type:"long"`
// Specifies the unique Amazon Resource Name (ARN) for the outpost.
OutpostArn *string `type:"string"`
// Specifies the unique identifier for the outpost.
OutpostId *string `type:"string"`
// Returns the Amazon Web Services account ID of the outpost owner. Useful for
// comparing owned versus shared outposts.
OwnerId *string `type:"string"`
// Specifies the unique S3 on Outposts ARN for use with Resource Access Manager
// (RAM).
S3OutpostArn *string `type:"string"`
// contains filtered or unexported fields
}
Contains the details for the Outpost object.
func (s Outpost) 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 (s *Outpost) SetCapacityInBytes(v int64) *Outpost
SetCapacityInBytes sets the CapacityInBytes field's value.
func (s *Outpost) SetOutpostArn(v string) *Outpost
SetOutpostArn sets the OutpostArn field's value.
func (s *Outpost) SetOutpostId(v string) *Outpost
SetOutpostId sets the OutpostId field's value.
func (s *Outpost) SetOwnerId(v string) *Outpost
SetOwnerId sets the OwnerId field's value.
func (s *Outpost) SetS3OutpostArn(v string) *Outpost
SetS3OutpostArn sets the S3OutpostArn field's value.
func (s Outpost) 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 OutpostOfflineException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The service link connection to your Outposts home Region is down. Check your connection and try again.
func (s *OutpostOfflineException) Code() string
Code returns the exception type name.
func (s *OutpostOfflineException) Error() string
func (s OutpostOfflineException) 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 (s *OutpostOfflineException) Message() string
Message returns the exception's message.
func (s *OutpostOfflineException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *OutpostOfflineException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *OutpostOfflineException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s OutpostOfflineException) 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 struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The requested resource was not found.
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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(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 (c *S3Outposts) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error)
CreateEndpoint API operation for Amazon S3 on Outposts.
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)
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.
ThrottlingException The request was denied due to request throttling.
OutpostOfflineException The service link connection to your Outposts home Region is down. Check your connection and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/CreateEndpoint
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 (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 (c *S3Outposts) DeleteEndpoint(input *DeleteEndpointInput) (*DeleteEndpointOutput, error)
DeleteEndpoint API operation for Amazon S3 on Outposts.
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)
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.
ThrottlingException The request was denied due to request throttling.
OutpostOfflineException The service link connection to your Outposts home Region is down. Check your connection and try again.
See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/DeleteEndpoint
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 (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 (c *S3Outposts) ListEndpoints(input *ListEndpointsInput) (*ListEndpointsOutput, error)
ListEndpoints API operation for Amazon S3 on Outposts.
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)
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.
ThrottlingException The request was denied due to request throttling.
See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListEndpoints
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 (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 (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 (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.
func (c *S3Outposts) ListOutpostsWithS3(input *ListOutpostsWithS3Input) (*ListOutpostsWithS3Output, error)
ListOutpostsWithS3 API operation for Amazon S3 on Outposts.
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).
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 ListOutpostsWithS3 for usage and error information.
Returned Error Types:
InternalServerException There was an exception with the internal server.
AccessDeniedException Access was denied for this action.
ValidationException There was an exception validating this data.
ThrottlingException The request was denied due to request throttling.
See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListOutpostsWithS3
func (c *S3Outposts) ListOutpostsWithS3Pages(input *ListOutpostsWithS3Input, fn func(*ListOutpostsWithS3Output, bool) bool) error
ListOutpostsWithS3Pages iterates over the pages of a ListOutpostsWithS3 operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListOutpostsWithS3 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 ListOutpostsWithS3 operation.
pageNum := 0
err := client.ListOutpostsWithS3Pages(params,
func(page *s3outposts.ListOutpostsWithS3Output, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *S3Outposts) ListOutpostsWithS3PagesWithContext(ctx aws.Context, input *ListOutpostsWithS3Input, fn func(*ListOutpostsWithS3Output, bool) bool, opts ...request.Option) error
ListOutpostsWithS3PagesWithContext same as ListOutpostsWithS3Pages 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 (c *S3Outposts) ListOutpostsWithS3Request(input *ListOutpostsWithS3Input) (req *request.Request, output *ListOutpostsWithS3Output)
ListOutpostsWithS3Request generates a "aws/request.Request" representing the client's request for the ListOutpostsWithS3 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 ListOutpostsWithS3 for more information on using the ListOutpostsWithS3 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 ListOutpostsWithS3Request method.
req, resp := client.ListOutpostsWithS3Request(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/ListOutpostsWithS3
func (c *S3Outposts) ListOutpostsWithS3WithContext(ctx aws.Context, input *ListOutpostsWithS3Input, opts ...request.Option) (*ListOutpostsWithS3Output, error)
ListOutpostsWithS3WithContext is the same as ListOutpostsWithS3 with the addition of the ability to pass a context and additional request options.
See ListOutpostsWithS3 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 (c *S3Outposts) ListSharedEndpoints(input *ListSharedEndpointsInput) (*ListSharedEndpointsOutput, error)
ListSharedEndpoints API operation for Amazon S3 on Outposts.
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)
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 ListSharedEndpoints 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.
ThrottlingException The request was denied due to request throttling.
See also, https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/ListSharedEndpoints
func (c *S3Outposts) ListSharedEndpointsPages(input *ListSharedEndpointsInput, fn func(*ListSharedEndpointsOutput, bool) bool) error
ListSharedEndpointsPages iterates over the pages of a ListSharedEndpoints operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListSharedEndpoints 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 ListSharedEndpoints operation.
pageNum := 0
err := client.ListSharedEndpointsPages(params,
func(page *s3outposts.ListSharedEndpointsOutput, lastPage bool) bool {
pageNum++
fmt.Println(page)
return pageNum <= 3
})
func (c *S3Outposts) ListSharedEndpointsPagesWithContext(ctx aws.Context, input *ListSharedEndpointsInput, fn func(*ListSharedEndpointsOutput, bool) bool, opts ...request.Option) error
ListSharedEndpointsPagesWithContext same as ListSharedEndpointsPages 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 (c *S3Outposts) ListSharedEndpointsRequest(input *ListSharedEndpointsInput) (req *request.Request, output *ListSharedEndpointsOutput)
ListSharedEndpointsRequest generates a "aws/request.Request" representing the client's request for the ListSharedEndpoints 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 ListSharedEndpoints for more information on using the ListSharedEndpoints 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 ListSharedEndpointsRequest method.
req, resp := client.ListSharedEndpointsRequest(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/ListSharedEndpoints
func (c *S3Outposts) ListSharedEndpointsWithContext(ctx aws.Context, input *ListSharedEndpointsInput, opts ...request.Option) (*ListSharedEndpointsOutput, error)
ListSharedEndpointsWithContext is the same as ListSharedEndpoints with the addition of the ability to pass a context and additional request options.
See ListSharedEndpoints 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 ThrottlingException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The request was denied due to request throttling.
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) 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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) 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 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 (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
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 (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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".