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.
Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type CancelOrderInput
- type CancelOrderOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CancelOrder(ctx context.Context, params *CancelOrderInput, optFns ...func(*Options)) (*CancelOrderOutput, error)
- func (c *Client) CreateOrder(ctx context.Context, params *CreateOrderInput, optFns ...func(*Options)) (*CreateOrderOutput, error)
- func (c *Client) CreateOutpost(ctx context.Context, params *CreateOutpostInput, optFns ...func(*Options)) (*CreateOutpostOutput, error)
- func (c *Client) CreateSite(ctx context.Context, params *CreateSiteInput, optFns ...func(*Options)) (*CreateSiteOutput, 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) GetCatalogItem(ctx context.Context, params *GetCatalogItemInput, optFns ...func(*Options)) (*GetCatalogItemOutput, error)
- func (c *Client) GetOrder(ctx context.Context, params *GetOrderInput, optFns ...func(*Options)) (*GetOrderOutput, 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) GetSite(ctx context.Context, params *GetSiteInput, optFns ...func(*Options)) (*GetSiteOutput, error)
- func (c *Client) GetSiteAddress(ctx context.Context, params *GetSiteAddressInput, optFns ...func(*Options)) (*GetSiteAddressOutput, error)
- func (c *Client) ListCatalogItems(ctx context.Context, params *ListCatalogItemsInput, optFns ...func(*Options)) (*ListCatalogItemsOutput, error)
- func (c *Client) ListOrders(ctx context.Context, params *ListOrdersInput, optFns ...func(*Options)) (*ListOrdersOutput, 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)
- func (c *Client) UpdateOutpost(ctx context.Context, params *UpdateOutpostInput, optFns ...func(*Options)) (*UpdateOutpostOutput, error)
- func (c *Client) UpdateSite(ctx context.Context, params *UpdateSiteInput, optFns ...func(*Options)) (*UpdateSiteOutput, error)
- func (c *Client) UpdateSiteAddress(ctx context.Context, params *UpdateSiteAddressInput, optFns ...func(*Options)) (*UpdateSiteAddressOutput, error)
- func (c *Client) UpdateSiteRackPhysicalProperties(ctx context.Context, params *UpdateSiteRackPhysicalPropertiesInput, optFns ...func(*Options)) (*UpdateSiteRackPhysicalPropertiesOutput, error)
- type CreateOrderInput
- type CreateOrderOutput
- type CreateOutpostInput
- type CreateOutpostOutput
- type CreateSiteInput
- type CreateSiteOutput
- type DeleteOutpostInput
- type DeleteOutpostOutput
- type DeleteSiteInput
- type DeleteSiteOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GetCatalogItemInput
- type GetCatalogItemOutput
- type GetOrderInput
- type GetOrderOutput
- type GetOutpostInput
- type GetOutpostInstanceTypesInput
- type GetOutpostInstanceTypesOutput
- type GetOutpostOutput
- type GetSiteAddressInput
- type GetSiteAddressOutput
- type GetSiteInput
- type GetSiteOutput
- type HTTPClient
- type HTTPSignerV4
- type ListCatalogItemsAPIClient
- type ListCatalogItemsInput
- type ListCatalogItemsOutput
- type ListCatalogItemsPaginator
- func NewListCatalogItemsPaginator(client ListCatalogItemsAPIClient, params *ListCatalogItemsInput, optFns ...func(*ListCatalogItemsPaginatorOptions)) *ListCatalogItemsPaginator
- func (p *ListCatalogItemsPaginator) HasMorePages() bool
- func (p *ListCatalogItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCatalogItemsOutput, error)
- type ListCatalogItemsPaginatorOptions
- type ListOrdersAPIClient
- type ListOrdersInput
- type ListOrdersOutput
- type ListOrdersPaginator
- func NewListOrdersPaginator(client ListOrdersAPIClient, params *ListOrdersInput, optFns ...func(*ListOrdersPaginatorOptions)) *ListOrdersPaginator
- func (p *ListOrdersPaginator) HasMorePages() bool
- func (p *ListOrdersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrdersOutput, error)
- type ListOrdersPaginatorOptions
- 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
- type UpdateOutpostInput
- type UpdateOutpostOutput
- type UpdateSiteAddressInput
- type UpdateSiteAddressOutput
- type UpdateSiteInput
- type UpdateSiteOutput
- type UpdateSiteRackPhysicalPropertiesInput
- type UpdateSiteRackPhysicalPropertiesOutput
Constants ¶
const ServiceAPIVersion = "2019-12-03"
const ServiceID = "Outposts"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type CancelOrderInput ¶
type CancelOrderInput struct { // The ID of the order to cancel. // // This member is required. OrderId *string // contains filtered or unexported fields }
type CancelOrderOutput ¶
type CancelOrderOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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) CancelOrder ¶
func (c *Client) CancelOrder(ctx context.Context, params *CancelOrderInput, optFns ...func(*Options)) (*CancelOrderOutput, error)
Cancels an order for an Outpost.
func (*Client) CreateOrder ¶
func (c *Client) CreateOrder(ctx context.Context, params *CreateOrderInput, optFns ...func(*Options)) (*CreateOrderOutput, error)
Creates an order for an Outpost.
func (*Client) CreateOutpost ¶
func (c *Client) CreateOutpost(ctx context.Context, params *CreateOutpostInput, optFns ...func(*Options)) (*CreateOutpostOutput, error)
Creates an Outpost. You can specify AvailabilityZone or AvailabilityZoneId.
func (*Client) CreateSite ¶
func (c *Client) CreateSite(ctx context.Context, params *CreateSiteInput, optFns ...func(*Options)) (*CreateSiteOutput, error)
Creates a site for 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) GetCatalogItem ¶
func (c *Client) GetCatalogItem(ctx context.Context, params *GetCatalogItemInput, optFns ...func(*Options)) (*GetCatalogItemOutput, error)
Gets information about a catalog item.
func (*Client) GetOrder ¶
func (c *Client) GetOrder(ctx context.Context, params *GetOrderInput, optFns ...func(*Options)) (*GetOrderOutput, error)
Gets an order.
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) GetSite ¶
func (c *Client) GetSite(ctx context.Context, params *GetSiteInput, optFns ...func(*Options)) (*GetSiteOutput, error)
Gets information about the specified Outpost site.
func (*Client) GetSiteAddress ¶
func (c *Client) GetSiteAddress(ctx context.Context, params *GetSiteAddressInput, optFns ...func(*Options)) (*GetSiteAddressOutput, error)
Gets the site address.
func (*Client) ListCatalogItems ¶
func (c *Client) ListCatalogItems(ctx context.Context, params *ListCatalogItemsInput, optFns ...func(*Options)) (*ListCatalogItemsOutput, error)
Use to create a list of every item in the catalog. Add filters to your request to return a more specific list of results. Use filters to match an item class, storage option, or EC2 family. If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
func (*Client) ListOrders ¶
func (c *Client) ListOrders(ctx context.Context, params *ListOrdersInput, optFns ...func(*Options)) (*ListOrdersOutput, error)
Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to return a more specific list of results.
func (*Client) ListOutposts ¶
func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, optFns ...func(*Options)) (*ListOutpostsOutput, error)
Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return a more specific list of results. Use filters to match an Outpost lifecycle status, Availability Zone (us-east-1a), and AZ ID (use1-az1). If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
func (*Client) ListSites ¶
func (c *Client) ListSites(ctx context.Context, params *ListSitesInput, optFns ...func(*Options)) (*ListSitesOutput, error)
Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to return a more specific list of results. Use filters to match site city, country code, or state/region of the operating address. If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
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.
func (*Client) UpdateOutpost ¶
func (c *Client) UpdateOutpost(ctx context.Context, params *UpdateOutpostInput, optFns ...func(*Options)) (*UpdateOutpostOutput, error)
Updates an Outpost.
func (*Client) UpdateSite ¶
func (c *Client) UpdateSite(ctx context.Context, params *UpdateSiteInput, optFns ...func(*Options)) (*UpdateSiteOutput, error)
Updates the site.
func (*Client) UpdateSiteAddress ¶
func (c *Client) UpdateSiteAddress(ctx context.Context, params *UpdateSiteAddressInput, optFns ...func(*Options)) (*UpdateSiteAddressOutput, error)
Updates the site address. To update a site address with an order IN_PROGRESS, you must wait for the order to complete or cancel the order. You can update the operating address before you place an order at the site, or after all Outposts that belong to the site have been deactivated.
func (*Client) UpdateSiteRackPhysicalProperties ¶
func (c *Client) UpdateSiteRackPhysicalProperties(ctx context.Context, params *UpdateSiteRackPhysicalPropertiesInput, optFns ...func(*Options)) (*UpdateSiteRackPhysicalPropertiesOutput, error)
Update the physical and logistical details for a rack at a site. For more information about hardware requirements for racks, see Network readiness checklist (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) in the Amazon Web Services Outposts User Guide. To update a rack at a site with an order of IN_PROGRESS, you must wait for the order to complete or cancel the order.
type CreateOrderInput ¶
type CreateOrderInput struct { // The line items that make up the order. // // This member is required. LineItems []types.LineItemRequest // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostIdentifier *string // The payment option for the order. // // This member is required. PaymentOption types.PaymentOption // The payment terms for the order. PaymentTerm types.PaymentTerm // contains filtered or unexported fields }
type CreateOrderOutput ¶
type CreateOrderOutput struct { // Information about this order. Order *types.Order // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateOutpostInput ¶
type CreateOutpostInput struct { // The name of the Outpost. // // This member is required. Name *string // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // The Availability Zone. AvailabilityZone *string // The ID of the Availability Zone. AvailabilityZoneId *string // The description of the Outpost. Description *string // The type of hardware for this Outpost. SupportedHardwareType types.SupportedHardwareType // The tags to apply to the Outpost. Tags map[string]string // contains filtered or unexported fields }
type CreateOutpostOutput ¶
type CreateOutpostOutput struct { // Information about an Outpost. Outpost *types.Outpost // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateSiteInput ¶
type CreateSiteInput struct { // The name of the site. // // This member is required. Name *string // The description of the site. Description *string // Additional information that you provide about site access requirements, // electrician scheduling, personal protective equipment, or regulation of // equipment materials that could affect your installation process. Notes *string // The location to install and power on the hardware. This address might be // different from the shipping address. OperatingAddress *types.Address // Information about the physical and logistical details for the rack at this site. // For more information about hardware requirements for racks, see Network // readiness checklist // (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist) // in the Amazon Web Services Outposts User Guide. RackPhysicalProperties *types.RackPhysicalProperties // The location to ship the hardware. This address might be different from the // operating address. ShippingAddress *types.Address // The tags to apply to a site. Tags map[string]string // contains filtered or unexported fields }
type CreateSiteOutput ¶
type CreateSiteOutput struct { // Information about a site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteOutpostInput ¶
type DeleteOutpostInput struct { // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostId *string // contains filtered or unexported fields }
type DeleteOutpostOutput ¶
type DeleteOutpostOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteSiteInput ¶
type DeleteSiteInput struct { // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // contains filtered or unexported fields }
type DeleteSiteOutput ¶
type DeleteSiteOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GetCatalogItemInput ¶
type GetCatalogItemInput struct { // The ID of the catalog item. // // This member is required. CatalogItemId *string // contains filtered or unexported fields }
type GetCatalogItemOutput ¶
type GetCatalogItemOutput struct { // Information about this catalog item. CatalogItem *types.CatalogItem // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOrderInput ¶
type GetOrderInput struct { // The ID of the order. // // This member is required. OrderId *string // contains filtered or unexported fields }
type GetOrderOutput ¶
type GetOrderOutput struct { // Information about an order. Order *types.Order // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetOutpostInput ¶
type GetOutpostInput struct { // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostId *string // contains filtered or unexported fields }
type GetOutpostInstanceTypesInput ¶
type GetOutpostInstanceTypesInput struct { // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostId *string // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type GetOutpostOutput ¶
type GetOutpostOutput struct { // Information about an Outpost. Outpost *types.Outpost // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSiteAddressInput ¶
type GetSiteAddressInput struct { // The type of the address you request. // // This member is required. AddressType types.AddressType // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // contains filtered or unexported fields }
type GetSiteAddressOutput ¶
type GetSiteAddressOutput struct { // Information about the address. Address *types.Address // The type of the address you receive. AddressType types.AddressType // The ID of the site. SiteId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSiteInput ¶
type GetSiteInput struct { // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // contains filtered or unexported fields }
type GetSiteOutput ¶
type GetSiteOutput struct { // Information about a site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 ListCatalogItemsAPIClient ¶
type ListCatalogItemsAPIClient interface { ListCatalogItems(context.Context, *ListCatalogItemsInput, ...func(*Options)) (*ListCatalogItemsOutput, error) }
ListCatalogItemsAPIClient is a client that implements the ListCatalogItems operation.
type ListCatalogItemsInput ¶
type ListCatalogItemsInput struct { // A filter for EC2 family options for items in the catalog. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. EC2FamilyFilter []string // A filter for the class of items in the catalog. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. ItemClassFilter []types.CatalogItemClass // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string // A filter for the storage options of items in the catalog. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. SupportedStorageFilter []types.SupportedStorageEnum // contains filtered or unexported fields }
type ListCatalogItemsOutput ¶
type ListCatalogItemsOutput struct { // Information about the catalog items. CatalogItems []types.CatalogItem // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListCatalogItemsPaginator ¶
type ListCatalogItemsPaginator struct {
// contains filtered or unexported fields
}
ListCatalogItemsPaginator is a paginator for ListCatalogItems
func NewListCatalogItemsPaginator ¶
func NewListCatalogItemsPaginator(client ListCatalogItemsAPIClient, params *ListCatalogItemsInput, optFns ...func(*ListCatalogItemsPaginatorOptions)) *ListCatalogItemsPaginator
NewListCatalogItemsPaginator returns a new ListCatalogItemsPaginator
func (*ListCatalogItemsPaginator) HasMorePages ¶
func (p *ListCatalogItemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListCatalogItemsPaginator) NextPage ¶
func (p *ListCatalogItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCatalogItemsOutput, error)
NextPage retrieves the next ListCatalogItems page.
type ListCatalogItemsPaginatorOptions ¶
type ListCatalogItemsPaginatorOptions 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 }
ListCatalogItemsPaginatorOptions is the paginator options for ListCatalogItems
type ListOrdersAPIClient ¶
type ListOrdersAPIClient interface { ListOrders(context.Context, *ListOrdersInput, ...func(*Options)) (*ListOrdersOutput, error) }
ListOrdersAPIClient is a client that implements the ListOrders operation.
type ListOrdersInput ¶
type ListOrdersInput struct { // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string // The ID or the Amazon Resource Name (ARN) of the Outpost. OutpostIdentifierFilter *string // contains filtered or unexported fields }
type ListOrdersOutput ¶
type ListOrdersOutput struct { // The pagination token. NextToken *string // Information about the orders. Orders []types.OrderSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListOrdersPaginator ¶
type ListOrdersPaginator struct {
// contains filtered or unexported fields
}
ListOrdersPaginator is a paginator for ListOrders
func NewListOrdersPaginator ¶
func NewListOrdersPaginator(client ListOrdersAPIClient, params *ListOrdersInput, optFns ...func(*ListOrdersPaginatorOptions)) *ListOrdersPaginator
NewListOrdersPaginator returns a new ListOrdersPaginator
func (*ListOrdersPaginator) HasMorePages ¶
func (p *ListOrdersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOrdersPaginator) NextPage ¶
func (p *ListOrdersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrdersOutput, error)
NextPage retrieves the next ListOrders page.
type ListOrdersPaginatorOptions ¶
type ListOrdersPaginatorOptions 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 }
ListOrdersPaginatorOptions is the paginator options for ListOrders
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 { // A filter for the Availability Zone (us-east-1a) of the Outpost. Filter values // are case sensitive. If you specify multiple values for a filter, the values are // joined with an OR, and the request returns all results that match any of the // specified values. AvailabilityZoneFilter []string // A filter for the AZ IDs (use1-az1) of the Outpost. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. AvailabilityZoneIdFilter []string // A filter for the lifecycle status of the Outpost. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. LifeCycleStatusFilter []string // The maximum page size. MaxResults *int32 // The pagination token. NextToken *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // A filter for the city of the Outpost site. Filter values are case sensitive. If // you specify multiple values for a filter, the values are joined with an OR, and // the request returns all results that match any of the specified values. OperatingAddressCityFilter []string // A filter for the country code of the Outpost site. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. OperatingAddressCountryCodeFilter []string // A filter for the state/region of the Outpost site. Filter values are case // sensitive. If you specify multiple values for a filter, the values are joined // with an OR, and the request returns all results that match any of the specified // values. OperatingAddressStateOrRegionFilter []string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The resource tags. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // 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 // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateOutpostInput ¶
type UpdateOutpostInput struct { // The ID or the Amazon Resource Name (ARN) of the Outpost. // // This member is required. OutpostId *string // The description of the Outpost. Description *string // The name of the Outpost. Name *string // The type of hardware for this Outpost. SupportedHardwareType types.SupportedHardwareType // contains filtered or unexported fields }
type UpdateOutpostOutput ¶
type UpdateOutpostOutput struct { // Information about an Outpost. Outpost *types.Outpost // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateSiteAddressInput ¶
type UpdateSiteAddressInput struct { // The address for the site. // // This member is required. Address *types.Address // The type of the address. // // This member is required. AddressType types.AddressType // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // contains filtered or unexported fields }
type UpdateSiteAddressOutput ¶
type UpdateSiteAddressOutput struct { // Information about an address. Address *types.Address // The type of the address. AddressType types.AddressType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateSiteInput ¶
type UpdateSiteInput struct { // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // The description of the site. Description *string // The name of the site. Name *string // Notes about a site. Notes *string // contains filtered or unexported fields }
type UpdateSiteOutput ¶
type UpdateSiteOutput struct { // Information about a site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateSiteRackPhysicalPropertiesInput ¶
type UpdateSiteRackPhysicalPropertiesInput struct { // The ID or the Amazon Resource Name (ARN) of the site. // // This member is required. SiteId *string // Specify the type of fiber that you will use to attach the Outpost to your // network. FiberOpticCableType types.FiberOpticCableType // Specify the maximum rack weight that this site can support. NO_LIMIT is over // 2000lbs. MaximumSupportedWeightLbs types.MaximumSupportedWeightLbs // Specify the type of optical standard that you will use to attach the Outpost to // your network. This field is dependent on uplink speed, fiber type, and distance // to the upstream device. For more information about networking requirements for // racks, see Network // (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking) // in the Amazon Web Services Outposts User Guide. // // * OPTIC_10GBASE_SR: // 10GBASE-SR // // * OPTIC_10GBASE_IR: 10GBASE-IR // // * OPTIC_10GBASE_LR: 10GBASE-LR // // * // OPTIC_40GBASE_SR: 40GBASE-SR // // * OPTIC_40GBASE_ESR: 40GBASE-ESR // // * // OPTIC_40GBASE_IR4_LR4L: 40GBASE-IR (LR4L) // // * OPTIC_40GBASE_LR4: 40GBASE-LR4 // // * // OPTIC_100GBASE_SR4: 100GBASE-SR4 // // * OPTIC_100GBASE_CWDM4: 100GBASE-CWDM4 // // * // OPTIC_100GBASE_LR4: 100GBASE-LR4 // // * OPTIC_100G_PSM4_MSA: 100G PSM4 MSA // // * // OPTIC_1000BASE_LX: 1000Base-LX // // * OPTIC_1000BASE_SX : 1000Base-SX OpticalStandard types.OpticalStandard // Specify the power connector that Amazon Web Services should plan to provide for // connections to the hardware. Note the correlation between PowerPhase and // PowerConnector. // // * Single-phase AC feed // // * L6-30P – (common in US); 30A; single // phase // // * IEC309 (blue) – P+N+E, 6hr; 32 A; single phase // // * Three-phase AC // feed // // * AH530P7W (red) – 3P+N+E, 7hr; 30A; three phase // // * AH532P6W (red) – // 3P+N+E, 6hr; 32A; three phase PowerConnector types.PowerConnector // Specify in kVA the power draw available at the hardware placement position for // the rack. PowerDrawKva types.PowerDrawKva // Specify whether the power feed comes above or below the rack. PowerFeedDrop types.PowerFeedDrop // Specify the power option that you can provide for hardware. // // * Single-phase AC // feed: 200 V to 277 V, 50 Hz or 60 Hz // // * Three-phase AC feed: 346 V to 480 V, 50 // Hz or 60 Hz PowerPhase types.PowerPhase // Racks come with two Outpost network devices. Depending on the supported uplink // speed at the site, the Outpost network devices provide a variable number of // uplinks. Specify the number of uplinks for each Outpost network device that you // intend to use to connect the rack to your network. Note the correlation between // UplinkGbps and UplinkCount. // // * 1Gbps - Uplinks available: 1, 2, 4, 6, 8 // // * // 10Gbps - Uplinks available: 1, 2, 4, 8, 12, 16 // // * 40 and 100 Gbps- Uplinks // available: 1, 2, 4 UplinkCount types.UplinkCount // Specify the uplink speed the rack should support for the connection to the // Region. UplinkGbps types.UplinkGbps // contains filtered or unexported fields }
type UpdateSiteRackPhysicalPropertiesOutput ¶
type UpdateSiteRackPhysicalPropertiesOutput struct { // Information about a site. Site *types.Site // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
api_client.go api_op_CancelOrder.go api_op_CreateOrder.go api_op_CreateOutpost.go api_op_CreateSite.go api_op_DeleteOutpost.go api_op_DeleteSite.go api_op_GetCatalogItem.go api_op_GetOrder.go api_op_GetOutpost.go api_op_GetOutpostInstanceTypes.go api_op_GetSite.go api_op_GetSiteAddress.go api_op_ListCatalogItems.go api_op_ListOrders.go api_op_ListOutposts.go api_op_ListSites.go api_op_ListTagsForResource.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateOutpost.go api_op_UpdateSite.go api_op_UpdateSiteAddress.go api_op_UpdateSiteRackPhysicalProperties.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.18.4
- Published
- Apr 25, 2022
- Platform
- windows/amd64
- Imports
- 32 packages
- Last checked
- 1 week ago –
Tools for package owners.