outposts

package module
v1.39.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2024 License: Apache-2.0 Imports: 39 Imported by: 14

Documentation

Overview

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

View Source
const ServiceAPIVersion = "2019-12-03"
View Source
const ServiceID = "Outposts"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

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

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

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.29.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.33.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.33.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.33.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.33.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type CancelCapacityTaskInput added in v1.39.0

type CancelCapacityTaskInput struct {

	// ID of the capacity task that you want to cancel.
	//
	// This member is required.
	CapacityTaskId *string

	// ID or ARN of the Outpost associated with the capacity task that you want to
	// cancel.
	//
	// This member is required.
	OutpostIdentifier *string
	// contains filtered or unexported fields
}

type CancelCapacityTaskOutput added in v1.39.0

type CancelCapacityTaskOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CancelOrderInput added in v1.11.0

type CancelOrderInput struct {

	//  The ID of the order.
	//
	// This member is required.
	OrderId *string
	// contains filtered or unexported fields
}

type CancelOrderOutput added in v1.11.0

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

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

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

func NewFromConfig

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

NewFromConfig returns a new client from the provided config.

func (*Client) CancelCapacityTask added in v1.39.0

func (c *Client) CancelCapacityTask(ctx context.Context, params *CancelCapacityTaskInput, optFns ...func(*Options)) (*CancelCapacityTaskOutput, error)

Cancels the capacity task.

func (*Client) CancelOrder added in v1.11.0

func (c *Client) CancelOrder(ctx context.Context, params *CancelOrderInput, optFns ...func(*Options)) (*CancelOrderOutput, error)

Cancels the specified order for an Outpost.

func (*Client) CreateOrder added in v1.8.0

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 either an Availability one or an AZ ID.

func (*Client) CreateSite added in v1.11.0

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 specified Outpost.

func (*Client) DeleteSite

func (c *Client) DeleteSite(ctx context.Context, params *DeleteSiteInput, optFns ...func(*Options)) (*DeleteSiteOutput, error)

Deletes the specified site.

func (*Client) GetCapacityTask added in v1.39.0

func (c *Client) GetCapacityTask(ctx context.Context, params *GetCapacityTaskInput, optFns ...func(*Options)) (*GetCapacityTaskOutput, error)

Gets details of the specified capacity task.

func (*Client) GetCatalogItem added in v1.11.0

func (c *Client) GetCatalogItem(ctx context.Context, params *GetCatalogItemInput, optFns ...func(*Options)) (*GetCatalogItemOutput, error)

Gets information about the specified catalog item.

func (*Client) GetConnection added in v1.20.0

func (c *Client) GetConnection(ctx context.Context, params *GetConnectionInput, optFns ...func(*Options)) (*GetConnectionOutput, error)
Amazon Web Services uses this action to install Outpost servers.

Gets information about the specified connection.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outpostsand Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

func (*Client) GetOrder added in v1.11.0

func (c *Client) GetOrder(ctx context.Context, params *GetOrderInput, optFns ...func(*Options)) (*GetOrderOutput, error)

Gets information about the specified 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)

Gets the instance types for the specified Outpost.

func (*Client) GetOutpostSupportedInstanceTypes added in v1.39.0

func (c *Client) GetOutpostSupportedInstanceTypes(ctx context.Context, params *GetOutpostSupportedInstanceTypesInput, optFns ...func(*Options)) (*GetOutpostSupportedInstanceTypesOutput, error)

Gets the instance types that an Outpost can support in InstanceTypeCapacity . This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.

func (*Client) GetSite added in v1.11.0

func (c *Client) GetSite(ctx context.Context, params *GetSiteInput, optFns ...func(*Options)) (*GetSiteOutput, error)

Gets information about the specified Outpost site.

func (*Client) GetSiteAddress added in v1.11.0

func (c *Client) GetSiteAddress(ctx context.Context, params *GetSiteAddressInput, optFns ...func(*Options)) (*GetSiteAddressOutput, error)

Gets the site address of the specified site.

func (*Client) ListAssets added in v1.19.0

func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error)

Lists the hardware assets for the specified Outpost.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

func (*Client) ListCapacityTasks added in v1.39.0

func (c *Client) ListCapacityTasks(ctx context.Context, params *ListCapacityTasksInput, optFns ...func(*Options)) (*ListCapacityTasksOutput, error)

Lists the capacity tasks for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

func (*Client) ListCatalogItems added in v1.11.0

func (c *Client) ListCatalogItems(ctx context.Context, params *ListCatalogItemsInput, optFns ...func(*Options)) (*ListCatalogItemsOutput, error)

Lists the items in the catalog.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

func (*Client) ListOrders added in v1.11.0

func (c *Client) ListOrders(ctx context.Context, params *ListOrdersInput, optFns ...func(*Options)) (*ListOrdersOutput, error)

Lists the Outpost orders for your Amazon Web Services account.

func (*Client) ListOutposts

func (c *Client) ListOutposts(ctx context.Context, params *ListOutpostsInput, optFns ...func(*Options)) (*ListOutpostsOutput, error)

Lists the Outposts for your Amazon Web Services account.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

func (*Client) ListSites

func (c *Client) ListSites(ctx context.Context, params *ListSitesInput, optFns ...func(*Options)) (*ListSitesOutput, error)

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

func (*Client) ListTagsForResource added in v0.31.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags for the specified resource.

func (*Client) Options added in v1.34.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartCapacityTask added in v1.39.0

func (c *Client) StartCapacityTask(ctx context.Context, params *StartCapacityTaskInput, optFns ...func(*Options)) (*StartCapacityTaskOutput, error)

Starts the specified capacity task. You can have one active capacity task for an order.

func (*Client) StartConnection added in v1.20.0

func (c *Client) StartConnection(ctx context.Context, params *StartConnectionInput, optFns ...func(*Options)) (*StartConnectionOutput, error)
Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outpostsand Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

func (*Client) TagResource added in v0.31.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to the specified resource.

func (*Client) UntagResource added in v0.31.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from the specified resource.

func (*Client) UpdateOutpost added in v1.13.0

func (c *Client) UpdateOutpost(ctx context.Context, params *UpdateOutpostInput, optFns ...func(*Options)) (*UpdateOutpostOutput, error)

Updates an Outpost.

func (*Client) UpdateSite added in v1.11.0

func (c *Client) UpdateSite(ctx context.Context, params *UpdateSiteInput, optFns ...func(*Options)) (*UpdateSiteOutput, error)

Updates the specified site.

func (*Client) UpdateSiteAddress added in v1.11.0

func (c *Client) UpdateSiteAddress(ctx context.Context, params *UpdateSiteAddressInput, optFns ...func(*Options)) (*UpdateSiteAddressOutput, error)

Updates the address of the specified site.

You can't update a site address if there is 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 added in v1.11.0

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 checklistin 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 added in v1.8.0

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.
	//
	// This member is required.
	PaymentOption types.PaymentOption

	// The payment terms.
	PaymentTerm types.PaymentTerm
	// contains filtered or unexported fields
}

type CreateOrderOutput added in v1.8.0

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 added in v1.11.0

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]in the
	// Amazon Web Services Outposts User Guide.
	//
	// [Network readiness checklist]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#checklist
	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 added in v1.11.0

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 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 EndpointParameters added in v1.29.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.29.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.29.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

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 added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.29.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.29.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetCapacityTaskInput added in v1.39.0

type GetCapacityTaskInput struct {

	// ID of the capacity task.
	//
	// This member is required.
	CapacityTaskId *string

	// ID or ARN of the Outpost associated with the specified capacity task.
	//
	// This member is required.
	OutpostIdentifier *string
	// contains filtered or unexported fields
}

type GetCapacityTaskOutput added in v1.39.0

type GetCapacityTaskOutput struct {

	// ID of the capacity task.
	CapacityTaskId *string

	// Status of the capacity task.
	//
	// A capacity task can have one of the following statuses:
	//
	//   - REQUESTED - The capacity task was created and is awaiting the next step by
	//   Amazon Web Services Outposts.
	//
	//   - IN_PROGRESS - The capacity task is running and cannot be cancelled.
	//
	//   - WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You
	//   must stop the recommended EC2 running instances to free up capacity for the task
	//   to run.
	CapacityTaskStatus types.CapacityTaskStatus

	// The date the capacity task ran successfully.
	CompletionDate *time.Time

	// The date the capacity task was created.
	CreationDate *time.Time

	// Performs a dry run to determine if you are above or below instance capacity.
	DryRun bool

	// Reason why the capacity task failed.
	Failed *types.CapacityTaskFailure

	// The date the capacity task was last modified.
	LastModifiedDate *time.Time

	// ID of the Amazon Web Services Outposts order associated with the specified
	// capacity task.
	OrderId *string

	// ID of the Outpost associated with the specified capacity task.
	OutpostId *string

	// List of instance pools requested in the capacity task.
	RequestedInstancePools []types.InstanceTypeCapacity

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetCatalogItemInput added in v1.11.0

type GetCatalogItemInput struct {

	// The ID of the catalog item.
	//
	// This member is required.
	CatalogItemId *string
	// contains filtered or unexported fields
}

type GetCatalogItemOutput added in v1.11.0

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 GetConnectionInput added in v1.20.0

type GetConnectionInput struct {

	//  The ID of the connection.
	//
	// This member is required.
	ConnectionId *string
	// contains filtered or unexported fields
}

type GetConnectionOutput added in v1.20.0

type GetConnectionOutput struct {

	//  Information about the connection.
	ConnectionDetails *types.ConnectionDetails

	//  The ID of the connection.
	ConnectionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetOrderInput added in v1.11.0

type GetOrderInput struct {

	// The ID of the order.
	//
	// This member is required.
	OrderId *string
	// contains filtered or unexported fields
}

type GetOrderOutput added in v1.11.0

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 ARN of the Outpost.
	//
	// This member is required.
	OutpostId *string
	// contains filtered or unexported fields
}

type GetOutpostInstanceTypesAPIClient added in v1.19.0

type GetOutpostInstanceTypesAPIClient interface {
	GetOutpostInstanceTypes(context.Context, *GetOutpostInstanceTypesInput, ...func(*Options)) (*GetOutpostInstanceTypesOutput, error)
}

GetOutpostInstanceTypesAPIClient is a client that implements the GetOutpostInstanceTypes operation.

type GetOutpostInstanceTypesInput

type GetOutpostInstanceTypesInput struct {

	//  The ID or 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 GetOutpostInstanceTypesPaginator added in v1.19.0

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

GetOutpostInstanceTypesPaginator is a paginator for GetOutpostInstanceTypes

func NewGetOutpostInstanceTypesPaginator added in v1.19.0

NewGetOutpostInstanceTypesPaginator returns a new GetOutpostInstanceTypesPaginator

func (*GetOutpostInstanceTypesPaginator) HasMorePages added in v1.19.0

func (p *GetOutpostInstanceTypesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetOutpostInstanceTypesPaginator) NextPage added in v1.19.0

NextPage retrieves the next GetOutpostInstanceTypes page.

type GetOutpostInstanceTypesPaginatorOptions added in v1.19.0

type GetOutpostInstanceTypesPaginatorOptions 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
}

GetOutpostInstanceTypesPaginatorOptions is the paginator options for GetOutpostInstanceTypes

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 GetOutpostSupportedInstanceTypesAPIClient added in v1.39.0

type GetOutpostSupportedInstanceTypesAPIClient interface {
	GetOutpostSupportedInstanceTypes(context.Context, *GetOutpostSupportedInstanceTypesInput, ...func(*Options)) (*GetOutpostSupportedInstanceTypesOutput, error)
}

GetOutpostSupportedInstanceTypesAPIClient is a client that implements the GetOutpostSupportedInstanceTypes operation.

type GetOutpostSupportedInstanceTypesInput added in v1.39.0

type GetOutpostSupportedInstanceTypesInput struct {

	// The ID for the Amazon Web Services Outposts order.
	//
	// This member is required.
	OrderId *string

	// The ID or ARN of the Outpost.
	//
	// This member is required.
	OutpostIdentifier *string

	// The maximum page size.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

type GetOutpostSupportedInstanceTypesOutput added in v1.39.0

type GetOutpostSupportedInstanceTypesOutput struct {

	// Information about the instance types.
	InstanceTypes []types.InstanceTypeItem

	// The pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetOutpostSupportedInstanceTypesPaginator added in v1.39.0

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

GetOutpostSupportedInstanceTypesPaginator is a paginator for GetOutpostSupportedInstanceTypes

func NewGetOutpostSupportedInstanceTypesPaginator added in v1.39.0

NewGetOutpostSupportedInstanceTypesPaginator returns a new GetOutpostSupportedInstanceTypesPaginator

func (*GetOutpostSupportedInstanceTypesPaginator) HasMorePages added in v1.39.0

HasMorePages returns a boolean indicating whether more pages are available

func (*GetOutpostSupportedInstanceTypesPaginator) NextPage added in v1.39.0

NextPage retrieves the next GetOutpostSupportedInstanceTypes page.

type GetOutpostSupportedInstanceTypesPaginatorOptions added in v1.39.0

type GetOutpostSupportedInstanceTypesPaginatorOptions 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
}

GetOutpostSupportedInstanceTypesPaginatorOptions is the paginator options for GetOutpostSupportedInstanceTypes

type GetSiteAddressInput added in v1.11.0

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 added in v1.11.0

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 added in v1.11.0

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 added in v1.11.0

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 HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

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

type ListAssetsAPIClient added in v1.19.0

type ListAssetsAPIClient interface {
	ListAssets(context.Context, *ListAssetsInput, ...func(*Options)) (*ListAssetsOutput, error)
}

ListAssetsAPIClient is a client that implements the ListAssets operation.

type ListAssetsInput added in v1.19.0

type ListAssetsInput struct {

	//  The ID or the Amazon Resource Name (ARN) of the Outpost.
	//
	// This member is required.
	OutpostIdentifier *string

	// Filters the results by the host ID of a Dedicated Host.
	HostIdFilter []string

	// The maximum page size.
	MaxResults *int32

	// The pagination token.
	NextToken *string

	// Filters the results by state.
	StatusFilter []types.AssetState
	// contains filtered or unexported fields
}

type ListAssetsOutput added in v1.19.0

type ListAssetsOutput struct {

	// Information about the hardware assets.
	Assets []types.AssetInfo

	// The pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAssetsPaginator added in v1.19.0

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

ListAssetsPaginator is a paginator for ListAssets

func NewListAssetsPaginator added in v1.19.0

func NewListAssetsPaginator(client ListAssetsAPIClient, params *ListAssetsInput, optFns ...func(*ListAssetsPaginatorOptions)) *ListAssetsPaginator

NewListAssetsPaginator returns a new ListAssetsPaginator

func (*ListAssetsPaginator) HasMorePages added in v1.19.0

func (p *ListAssetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetsPaginator) NextPage added in v1.19.0

func (p *ListAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetsOutput, error)

NextPage retrieves the next ListAssets page.

type ListAssetsPaginatorOptions added in v1.19.0

type ListAssetsPaginatorOptions 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
}

ListAssetsPaginatorOptions is the paginator options for ListAssets

type ListCapacityTasksAPIClient added in v1.39.0

type ListCapacityTasksAPIClient interface {
	ListCapacityTasks(context.Context, *ListCapacityTasksInput, ...func(*Options)) (*ListCapacityTasksOutput, error)
}

ListCapacityTasksAPIClient is a client that implements the ListCapacityTasks operation.

type ListCapacityTasksInput added in v1.39.0

type ListCapacityTasksInput struct {

	// A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION .
	CapacityTaskStatusFilter []types.CapacityTaskStatus

	// The maximum page size.
	MaxResults *int32

	// The pagination token.
	NextToken *string

	// Filters the results by an Outpost ID or an Outpost ARN.
	OutpostIdentifierFilter *string
	// contains filtered or unexported fields
}

type ListCapacityTasksOutput added in v1.39.0

type ListCapacityTasksOutput struct {

	// Lists all the capacity tasks.
	CapacityTasks []types.CapacityTaskSummary

	// The pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCapacityTasksPaginator added in v1.39.0

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

ListCapacityTasksPaginator is a paginator for ListCapacityTasks

func NewListCapacityTasksPaginator added in v1.39.0

func NewListCapacityTasksPaginator(client ListCapacityTasksAPIClient, params *ListCapacityTasksInput, optFns ...func(*ListCapacityTasksPaginatorOptions)) *ListCapacityTasksPaginator

NewListCapacityTasksPaginator returns a new ListCapacityTasksPaginator

func (*ListCapacityTasksPaginator) HasMorePages added in v1.39.0

func (p *ListCapacityTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCapacityTasksPaginator) NextPage added in v1.39.0

func (p *ListCapacityTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCapacityTasksOutput, error)

NextPage retrieves the next ListCapacityTasks page.

type ListCapacityTasksPaginatorOptions added in v1.39.0

type ListCapacityTasksPaginatorOptions 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
}

ListCapacityTasksPaginatorOptions is the paginator options for ListCapacityTasks

type ListCatalogItemsAPIClient added in v1.11.0

type ListCatalogItemsAPIClient interface {
	ListCatalogItems(context.Context, *ListCatalogItemsInput, ...func(*Options)) (*ListCatalogItemsOutput, error)
}

ListCatalogItemsAPIClient is a client that implements the ListCatalogItems operation.

type ListCatalogItemsInput added in v1.11.0

type ListCatalogItemsInput struct {

	// Filters the results by EC2 family (for example, M5).
	EC2FamilyFilter []string

	// Filters the results by item class.
	ItemClassFilter []types.CatalogItemClass

	// The maximum page size.
	MaxResults *int32

	// The pagination token.
	NextToken *string

	// Filters the results by storage option.
	SupportedStorageFilter []types.SupportedStorageEnum
	// contains filtered or unexported fields
}

type ListCatalogItemsOutput added in v1.11.0

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 added in v1.11.0

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

ListCatalogItemsPaginator is a paginator for ListCatalogItems

func NewListCatalogItemsPaginator added in v1.11.0

func NewListCatalogItemsPaginator(client ListCatalogItemsAPIClient, params *ListCatalogItemsInput, optFns ...func(*ListCatalogItemsPaginatorOptions)) *ListCatalogItemsPaginator

NewListCatalogItemsPaginator returns a new ListCatalogItemsPaginator

func (*ListCatalogItemsPaginator) HasMorePages added in v1.11.0

func (p *ListCatalogItemsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCatalogItemsPaginator) NextPage added in v1.11.0

func (p *ListCatalogItemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCatalogItemsOutput, error)

NextPage retrieves the next ListCatalogItems page.

type ListCatalogItemsPaginatorOptions added in v1.11.0

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 added in v1.11.0

type ListOrdersAPIClient interface {
	ListOrders(context.Context, *ListOrdersInput, ...func(*Options)) (*ListOrdersOutput, error)
}

ListOrdersAPIClient is a client that implements the ListOrders operation.

type ListOrdersInput added in v1.11.0

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 added in v1.11.0

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 added in v1.11.0

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

ListOrdersPaginator is a paginator for ListOrders

func NewListOrdersPaginator added in v1.11.0

func NewListOrdersPaginator(client ListOrdersAPIClient, params *ListOrdersInput, optFns ...func(*ListOrdersPaginatorOptions)) *ListOrdersPaginator

NewListOrdersPaginator returns a new ListOrdersPaginator

func (*ListOrdersPaginator) HasMorePages added in v1.11.0

func (p *ListOrdersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOrdersPaginator) NextPage added in v1.11.0

func (p *ListOrdersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOrdersOutput, error)

NextPage retrieves the next ListOrders page.

type ListOrdersPaginatorOptions added in v1.11.0

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 added in v0.30.0

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 {

	// Filters the results by Availability Zone (for example, us-east-1a ).
	AvailabilityZoneFilter []string

	// Filters the results by AZ ID (for example, use1-az1 ).
	AvailabilityZoneIdFilter []string

	// Filters the results by the lifecycle status.
	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 added in v0.30.0

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

ListOutpostsPaginator is a paginator for ListOutposts

func NewListOutpostsPaginator added in v0.30.0

func NewListOutpostsPaginator(client ListOutpostsAPIClient, params *ListOutpostsInput, optFns ...func(*ListOutpostsPaginatorOptions)) *ListOutpostsPaginator

NewListOutpostsPaginator returns a new ListOutpostsPaginator

func (*ListOutpostsPaginator) HasMorePages added in v0.30.0

func (p *ListOutpostsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListOutpostsPaginator) NextPage added in v0.30.0

func (p *ListOutpostsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOutpostsOutput, error)

NextPage retrieves the next ListOutposts page.

type ListOutpostsPaginatorOptions added in v0.30.0

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 added in v0.30.0

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

	// Filters the results by city.
	OperatingAddressCityFilter []string

	// Filters the results by country code.
	OperatingAddressCountryCodeFilter []string

	// Filters the results by state or region.
	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 added in v0.30.0

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

ListSitesPaginator is a paginator for ListSites

func NewListSitesPaginator added in v0.30.0

func NewListSitesPaginator(client ListSitesAPIClient, params *ListSitesInput, optFns ...func(*ListSitesPaginatorOptions)) *ListSitesPaginator

NewListSitesPaginator returns a new ListSitesPaginator

func (*ListSitesPaginator) HasMorePages added in v0.30.0

func (p *ListSitesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSitesPaginator) NextPage added in v0.30.0

func (p *ListSitesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSitesOutput, error)

NextPage retrieves the next ListSites page.

type ListSitesPaginatorOptions added in v0.30.0

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 added in v0.31.0

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v0.31.0

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// 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.
	//
	// 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

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

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

func (Options) GetIdentityResolver added in v1.33.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartCapacityTaskInput added in v1.39.0

type StartCapacityTaskInput struct {

	// The instance pools specified in the capacity task.
	//
	// This member is required.
	InstancePools []types.InstanceTypeCapacity

	// The ID of the Amazon Web Services Outposts order associated with the specified
	// capacity task.
	//
	// This member is required.
	OrderId *string

	// The ID or ARN of the Outposts associated with the specified capacity task.
	//
	// This member is required.
	OutpostIdentifier *string

	// You can request a dry run to determine if the instance type and instance size
	// changes is above or below available instance capacity. Requesting a dry run does
	// not make any changes to your plan.
	DryRun bool
	// contains filtered or unexported fields
}

type StartCapacityTaskOutput added in v1.39.0

type StartCapacityTaskOutput struct {

	// ID of the capacity task that you want to start.
	CapacityTaskId *string

	// Status of the specified capacity task.
	CapacityTaskStatus types.CapacityTaskStatus

	// Date that the specified capacity task ran successfully.
	CompletionDate *time.Time

	// Date that the specified capacity task was created.
	CreationDate *time.Time

	// Results of the dry run showing if the specified capacity task is above or below
	// the available instance capacity.
	DryRun bool

	// Reason that the specified capacity task failed.
	Failed *types.CapacityTaskFailure

	// Date that the specified capacity task was last modified.
	LastModifiedDate *time.Time

	// ID of the Amazon Web Services Outposts order of the host associated with the
	// capacity task.
	OrderId *string

	// ID of the Outpost associated with the capacity task.
	OutpostId *string

	// List of the instance pools requested in the specified capacity task.
	RequestedInstancePools []types.InstanceTypeCapacity

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartConnectionInput added in v1.20.0

type StartConnectionInput struct {

	//  The ID of the Outpost server.
	//
	// This member is required.
	AssetId *string

	//  The public key of the client.
	//
	// This member is required.
	ClientPublicKey *string

	//  The device index of the network interface on the Outpost server.
	//
	// This member is required.
	NetworkInterfaceDeviceIndex int32

	//  The serial number of the dongle.
	DeviceSerialNumber *string
	// contains filtered or unexported fields
}

type StartConnectionOutput added in v1.20.0

type StartConnectionOutput struct {

	//  The ID of the connection.
	ConnectionId *string

	//  The underlay IP address.
	UnderlayIpAddress *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput added in v0.31.0

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 added in v0.31.0

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v0.31.0

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 added in v0.31.0

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateOutpostInput added in v1.13.0

type UpdateOutpostInput struct {

	//  The ID or 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 added in v1.13.0

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 added in v1.11.0

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 added in v1.11.0

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 added in v1.11.0

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 added in v1.11.0

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 added in v1.11.0

type UpdateSiteRackPhysicalPropertiesInput struct {

	//  The ID or the Amazon Resource Name (ARN) of the site.
	//
	// This member is required.
	SiteId *string

	// The type of fiber that you will use to attach the Outpost to your network.
	FiberOpticCableType types.FiberOpticCableType

	// The maximum rack weight that this site can support. NO_LIMIT is over 2000lbs.
	MaximumSupportedWeightLbs types.MaximumSupportedWeightLbs

	// 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]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
	//
	// [Network]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-requirements.html#facility-networking
	OpticalStandard types.OpticalStandard

	// 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

	// The power draw, in kVA, available at the hardware placement position for the
	// rack.
	PowerDrawKva types.PowerDrawKva

	// Indicates whether the power feed comes above or below the rack.
	PowerFeedDrop types.PowerFeedDrop

	// 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

	// The uplink speed the rack should support for the connection to the Region.
	UplinkGbps types.UplinkGbps
	// contains filtered or unexported fields
}

type UpdateSiteRackPhysicalPropertiesOutput added in v1.11.0

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
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL