package outposts
import "github.com/aws/aws-sdk-go-v2/service/outposts"
Package outposts provides the API client, operations, and parameter types for AWS Outposts.
AWS Outposts is a fully managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateOutpost(ctx context.Context, params *CreateOutpostInput, optFns ...func(*Options)) (*CreateOutpostOutput, error)
- func (c *Client) DeleteOutpost(ctx context.Context, params *DeleteOutpostInput, optFns ...func(*Options)) (*DeleteOutpostOutput, error)
- func (c *Client) DeleteSite(ctx context.Context, params *DeleteSiteInput, optFns ...func(*Options)) (*DeleteSiteOutput, error)
- func (c *Client) GetOutpost(ctx context.Context, params *GetOutpostInput, optFns ...func(*Options)) (*GetOutpostOutput, error)
- func (c *Client) GetOutpostInstanceTypes(ctx context.Context, params *GetOutpostInstanceTypesInput, optFns ...func(*Options)) (*GetOutpostInstanceTypesOutput, error)
- func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, optFns ...func(*Options)) (*ListOutpostsOutput, error)
- func (c *Client) ListSites(ctx context.Context, params *ListSitesInput, optFns ...func(*Options)) (*ListSitesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- type CreateOutpostInput
- type CreateOutpostOutput
- type DeleteOutpostInput
- type DeleteOutpostOutput
- type DeleteSiteInput
- type DeleteSiteOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetOutpostInput
- type GetOutpostInstanceTypesInput
- type GetOutpostInstanceTypesOutput
- type GetOutpostOutput
- type HTTPClient
- type HTTPSignerV4
- type ListOutpostsAPIClient
- type ListOutpostsInput
- type ListOutpostsOutput
- type ListOutpostsPaginator
- func NewListOutpostsPaginator(client ListOutpostsAPIClient, params *ListOutpostsInput, optFns ...func(*ListOutpostsPaginatorOptions)) *ListOutpostsPaginator
- func (p *ListOutpostsPaginator) HasMorePages() bool
- func (p *ListOutpostsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOutpostsOutput, error)
- type ListOutpostsPaginatorOptions
- type ListSitesAPIClient
- type ListSitesInput
- type ListSitesOutput
- type ListSitesPaginator
- func NewListSitesPaginator(client ListSitesAPIClient, params *ListSitesInput, optFns ...func(*ListSitesPaginatorOptions)) *ListSitesPaginator
- func (p *ListSitesPaginator) HasMorePages() bool
- func (p *ListSitesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSitesOutput, error)
- type ListSitesPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
Constants ¶
const ServiceAPIVersion = "2019-12-03"
const ServiceID = "Outposts"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Outposts.
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateOutpost ¶
func (c *Client) CreateOutpost(ctx context.Context, params *CreateOutpostInput, optFns ...func(*Options)) (*CreateOutpostOutput, error)
Creates an Outpost.
func (*Client) DeleteOutpost ¶
func (c *Client) DeleteOutpost(ctx context.Context, params *DeleteOutpostInput, optFns ...func(*Options)) (*DeleteOutpostOutput, error)
Deletes the Outpost.
func (*Client) DeleteSite ¶
func (c *Client) DeleteSite(ctx context.Context, params *DeleteSiteInput, optFns ...func(*Options)) (*DeleteSiteOutput, error)
Deletes the site.
func (*Client) GetOutpost ¶
func (c *Client) GetOutpost(ctx context.Context, params *GetOutpostInput, optFns ...func(*Options)) (*GetOutpostOutput, error)
Gets information about the specified Outpost.
func (*Client) GetOutpostInstanceTypes ¶
func (c *Client) GetOutpostInstanceTypes(ctx context.Context, params *GetOutpostInstanceTypesInput, optFns ...func(*Options)) (*GetOutpostInstanceTypesOutput, error)
Lists the instance types for the specified Outpost.
func (*Client) ListOutposts ¶
func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, optFns ...func(*Options)) (*ListOutpostsOutput, error)
List the Outposts for your AWS account.
func (*Client) ListSites ¶
func (c *Client) ListSites(ctx context.Context, params *ListSitesInput, optFns ...func(*Options)) (*ListSitesOutput, error)
Lists the sites for the specified AWS account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for the specified resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds tags to the specified resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes tags from the specified resource.
type CreateOutpostInput ¶
type CreateOutpostInput struct { // The name of the Outpost. // // This member is required. Name *string // The ID of the site. // // This member is required. SiteId *string // The Availability Zone. You must specify AvailabilityZone or AvailabilityZoneId. AvailabilityZone *string // The ID of the Availability Zone. You must specify AvailabilityZone or // AvailabilityZoneId. AvailabilityZoneId *string // The description of the Outpost. Description *string // The tags to apply to the Outpost. Tags map[string]string }
type CreateOutpostOutput ¶
type CreateOutpostOutput struct { // Information about an Outpost. Outpost *types.Outpost // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteOutpostInput ¶
type DeleteOutpostInput struct { // The ID of the Outpost. // // This member is required. OutpostId *string }
type DeleteOutpostOutput ¶
type DeleteOutpostOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteSiteInput ¶
type DeleteSiteInput struct { // The ID of the site. // // This member is required. SiteId *string }
type DeleteSiteOutput ¶
type DeleteSiteOutput 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 WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
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 GetOutpostInput ¶
type GetOutpostInput struct { // The ID of the Outpost. // // This member is required. OutpostId *string }
type GetOutpostInstanceTypesInput ¶
type GetOutpostInstanceTypesInput struct { // The ID of the Outpost. // // This member is required. OutpostId *string // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string }
type GetOutpostInstanceTypesOutput ¶
type GetOutpostInstanceTypesOutput struct { // Information about the instance types. InstanceTypes []types.InstanceTypeItem // The pagination token. NextToken *string // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string // The ID of the Outpost. OutpostId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetOutpostOutput ¶
type GetOutpostOutput struct { // Information about an Outpost. Outpost *types.Outpost // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
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 ListOutpostsAPIClient ¶
type ListOutpostsAPIClient interface { ListOutposts(context.Context, *ListOutpostsInput, ...func(*Options)) (*ListOutpostsOutput, error) }
ListOutpostsAPIClient is a client that implements the ListOutposts operation.
type ListOutpostsInput ¶
type ListOutpostsInput struct { // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string }
type ListOutpostsOutput ¶
type ListOutpostsOutput struct { // The pagination token. NextToken *string // Information about the Outposts. Outposts []types.Outpost // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListOutpostsPaginator ¶
type ListOutpostsPaginator struct {
// contains filtered or unexported fields
}
ListOutpostsPaginator is a paginator for ListOutposts
func NewListOutpostsPaginator ¶
func NewListOutpostsPaginator(client ListOutpostsAPIClient, params *ListOutpostsInput, optFns ...func(*ListOutpostsPaginatorOptions)) *ListOutpostsPaginator
NewListOutpostsPaginator returns a new ListOutpostsPaginator
func (*ListOutpostsPaginator) HasMorePages ¶
func (p *ListOutpostsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOutpostsPaginator) NextPage ¶
func (p *ListOutpostsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOutpostsOutput, error)
NextPage retrieves the next ListOutposts page.
type ListOutpostsPaginatorOptions ¶
type ListOutpostsPaginatorOptions struct { // The maximum page size. 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 }
ListOutpostsPaginatorOptions is the paginator options for ListOutposts
type ListSitesAPIClient ¶
type ListSitesAPIClient interface { ListSites(context.Context, *ListSitesInput, ...func(*Options)) (*ListSitesOutput, error) }
ListSitesAPIClient is a client that implements the ListSites operation.
type ListSitesInput ¶
type ListSitesInput struct { // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string }
type ListSitesOutput ¶
type ListSitesOutput struct { // The pagination token. NextToken *string // Information about the sites. Sites []types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListSitesPaginator ¶
type ListSitesPaginator struct {
// contains filtered or unexported fields
}
ListSitesPaginator is a paginator for ListSites
func NewListSitesPaginator ¶
func NewListSitesPaginator(client ListSitesAPIClient, params *ListSitesInput, optFns ...func(*ListSitesPaginatorOptions)) *ListSitesPaginator
NewListSitesPaginator returns a new ListSitesPaginator
func (*ListSitesPaginator) HasMorePages ¶
func (p *ListSitesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSitesPaginator) NextPage ¶
func (p *ListSitesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSitesOutput, error)
NextPage retrieves the next ListSites page.
type ListSitesPaginatorOptions ¶
type ListSitesPaginatorOptions struct { // The maximum page size. 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 }
ListSitesPaginatorOptions is the paginator options for ListSites
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The resource tags. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
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
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tags to add to the resource. // // This member is required. Tags map[string]string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // The tag keys. // // This member is required. TagKeys []string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CreateOutpost.go api_op_DeleteOutpost.go api_op_DeleteSite.go api_op_GetOutpost.go api_op_GetOutpostInstanceTypes.go api_op_ListOutposts.go api_op_ListSites.go api_op_ListTagsForResource.go api_op_TagResource.go api_op_UntagResource.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.31.0
- Published
- Dec 24, 2020
- Platform
- linux/amd64
- Imports
- 26 packages
- Last checked
- 2 weeks ago –
Tools for package owners.