Documentation ¶
Overview ¶
Package outposts provides the client and types for making API requests to AWS Outposts.
AWS Outposts is a fully-managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS-managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
See https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03 for more information on this service.
See outposts package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/outposts/
Using the Client ¶
To contact AWS Outposts with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Outposts client Outposts for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/outposts/#New
Index ¶
- Constants
- type CreateOutpostInput
- func (s CreateOutpostInput) GoString() string
- func (s *CreateOutpostInput) SetAvailabilityZone(v string) *CreateOutpostInput
- func (s *CreateOutpostInput) SetAvailabilityZoneId(v string) *CreateOutpostInput
- func (s *CreateOutpostInput) SetDescription(v string) *CreateOutpostInput
- func (s *CreateOutpostInput) SetName(v string) *CreateOutpostInput
- func (s *CreateOutpostInput) SetSiteId(v string) *CreateOutpostInput
- func (s CreateOutpostInput) String() string
- func (s *CreateOutpostInput) Validate() error
- type CreateOutpostOutput
- type GetOutpostInput
- type GetOutpostInstanceTypesInput
- func (s GetOutpostInstanceTypesInput) GoString() string
- func (s *GetOutpostInstanceTypesInput) SetMaxResults(v int64) *GetOutpostInstanceTypesInput
- func (s *GetOutpostInstanceTypesInput) SetNextToken(v string) *GetOutpostInstanceTypesInput
- func (s *GetOutpostInstanceTypesInput) SetOutpostId(v string) *GetOutpostInstanceTypesInput
- func (s GetOutpostInstanceTypesInput) String() string
- func (s *GetOutpostInstanceTypesInput) Validate() error
- type GetOutpostInstanceTypesOutput
- func (s GetOutpostInstanceTypesOutput) GoString() string
- func (s *GetOutpostInstanceTypesOutput) SetInstanceTypes(v []*InstanceTypeItem) *GetOutpostInstanceTypesOutput
- func (s *GetOutpostInstanceTypesOutput) SetNextToken(v string) *GetOutpostInstanceTypesOutput
- func (s *GetOutpostInstanceTypesOutput) SetOutpostArn(v string) *GetOutpostInstanceTypesOutput
- func (s *GetOutpostInstanceTypesOutput) SetOutpostId(v string) *GetOutpostInstanceTypesOutput
- func (s GetOutpostInstanceTypesOutput) String() string
- type GetOutpostOutput
- type InstanceTypeItem
- type ListOutpostsInput
- type ListOutpostsOutput
- type ListSitesInput
- type ListSitesOutput
- type Outpost
- func (s Outpost) GoString() string
- func (s *Outpost) SetAvailabilityZone(v string) *Outpost
- func (s *Outpost) SetAvailabilityZoneId(v string) *Outpost
- func (s *Outpost) SetDescription(v string) *Outpost
- func (s *Outpost) SetLifeCycleStatus(v string) *Outpost
- func (s *Outpost) SetName(v string) *Outpost
- func (s *Outpost) SetOutpostArn(v string) *Outpost
- func (s *Outpost) SetOutpostId(v string) *Outpost
- func (s *Outpost) SetOwnerId(v string) *Outpost
- func (s *Outpost) SetSiteId(v string) *Outpost
- func (s Outpost) String() string
- type Outposts
- func (c *Outposts) CreateOutpost(input *CreateOutpostInput) (*CreateOutpostOutput, error)
- func (c *Outposts) CreateOutpostRequest(input *CreateOutpostInput) (req *request.Request, output *CreateOutpostOutput)
- func (c *Outposts) CreateOutpostWithContext(ctx aws.Context, input *CreateOutpostInput, opts ...request.Option) (*CreateOutpostOutput, error)
- func (c *Outposts) GetOutpost(input *GetOutpostInput) (*GetOutpostOutput, error)
- func (c *Outposts) GetOutpostInstanceTypes(input *GetOutpostInstanceTypesInput) (*GetOutpostInstanceTypesOutput, error)
- func (c *Outposts) GetOutpostInstanceTypesRequest(input *GetOutpostInstanceTypesInput) (req *request.Request, output *GetOutpostInstanceTypesOutput)
- func (c *Outposts) GetOutpostInstanceTypesWithContext(ctx aws.Context, input *GetOutpostInstanceTypesInput, opts ...request.Option) (*GetOutpostInstanceTypesOutput, error)
- func (c *Outposts) GetOutpostRequest(input *GetOutpostInput) (req *request.Request, output *GetOutpostOutput)
- func (c *Outposts) GetOutpostWithContext(ctx aws.Context, input *GetOutpostInput, opts ...request.Option) (*GetOutpostOutput, error)
- func (c *Outposts) ListOutposts(input *ListOutpostsInput) (*ListOutpostsOutput, error)
- func (c *Outposts) ListOutpostsPages(input *ListOutpostsInput, fn func(*ListOutpostsOutput, bool) bool) error
- func (c *Outposts) ListOutpostsPagesWithContext(ctx aws.Context, input *ListOutpostsInput, ...) error
- func (c *Outposts) ListOutpostsRequest(input *ListOutpostsInput) (req *request.Request, output *ListOutpostsOutput)
- func (c *Outposts) ListOutpostsWithContext(ctx aws.Context, input *ListOutpostsInput, opts ...request.Option) (*ListOutpostsOutput, error)
- func (c *Outposts) ListSites(input *ListSitesInput) (*ListSitesOutput, error)
- func (c *Outposts) ListSitesPages(input *ListSitesInput, fn func(*ListSitesOutput, bool) bool) error
- func (c *Outposts) ListSitesPagesWithContext(ctx aws.Context, input *ListSitesInput, fn func(*ListSitesOutput, bool) bool, ...) error
- func (c *Outposts) ListSitesRequest(input *ListSitesInput) (req *request.Request, output *ListSitesOutput)
- func (c *Outposts) ListSitesWithContext(ctx aws.Context, input *ListSitesInput, opts ...request.Option) (*ListSitesOutput, error)
- type Site
Constants ¶
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You do not have permission to perform this operation. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // An internal error has occurred. ErrCodeInternalServerException = "InternalServerException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // The specified request is not valid. ErrCodeNotFoundException = "NotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // You have exceeded a service quota. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeValidationException for service response error code // "ValidationException". // // A parameter is not valid. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "Outposts" // Name of service. EndpointsID = "outposts" // ID to lookup a service endpoint with. ServiceID = "Outposts" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateOutpostInput ¶
type CreateOutpostInput struct { // The Availability Zone. AvailabilityZone *string `min:"1" type:"string"` // The ID of the Availability Zone. AvailabilityZoneId *string `min:"1" type:"string"` // The Outpost description. Description *string `min:"1" type:"string"` // The name of the Outpost. Name *string `min:"1" type:"string"` // The ID of the site. // // SiteId is a required field SiteId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateOutpostInput) GoString ¶
func (s CreateOutpostInput) GoString() string
GoString returns the string representation
func (*CreateOutpostInput) SetAvailabilityZone ¶
func (s *CreateOutpostInput) SetAvailabilityZone(v string) *CreateOutpostInput
SetAvailabilityZone sets the AvailabilityZone field's value.
func (*CreateOutpostInput) SetAvailabilityZoneId ¶
func (s *CreateOutpostInput) SetAvailabilityZoneId(v string) *CreateOutpostInput
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (*CreateOutpostInput) SetDescription ¶
func (s *CreateOutpostInput) SetDescription(v string) *CreateOutpostInput
SetDescription sets the Description field's value.
func (*CreateOutpostInput) SetName ¶
func (s *CreateOutpostInput) SetName(v string) *CreateOutpostInput
SetName sets the Name field's value.
func (*CreateOutpostInput) SetSiteId ¶
func (s *CreateOutpostInput) SetSiteId(v string) *CreateOutpostInput
SetSiteId sets the SiteId field's value.
func (CreateOutpostInput) String ¶
func (s CreateOutpostInput) String() string
String returns the string representation
func (*CreateOutpostInput) Validate ¶
func (s *CreateOutpostInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateOutpostOutput ¶
type CreateOutpostOutput struct { // Information about an Outpost. Outpost *Outpost `type:"structure"` // contains filtered or unexported fields }
func (CreateOutpostOutput) GoString ¶
func (s CreateOutpostOutput) GoString() string
GoString returns the string representation
func (*CreateOutpostOutput) SetOutpost ¶
func (s *CreateOutpostOutput) SetOutpost(v *Outpost) *CreateOutpostOutput
SetOutpost sets the Outpost field's value.
func (CreateOutpostOutput) String ¶
func (s CreateOutpostOutput) String() string
String returns the string representation
type GetOutpostInput ¶
type GetOutpostInput struct { // The ID of the Outpost. // // OutpostId is a required field OutpostId *string `location:"uri" locationName:"OutpostId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetOutpostInput) GoString ¶
func (s GetOutpostInput) GoString() string
GoString returns the string representation
func (*GetOutpostInput) SetOutpostId ¶
func (s *GetOutpostInput) SetOutpostId(v string) *GetOutpostInput
SetOutpostId sets the OutpostId field's value.
func (GetOutpostInput) String ¶
func (s GetOutpostInput) String() string
String returns the string representation
func (*GetOutpostInput) Validate ¶
func (s *GetOutpostInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetOutpostInstanceTypesInput ¶
type GetOutpostInstanceTypesInput struct { // The maximum page size. MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"` // The pagination token. NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` // The ID of the Outpost. // // OutpostId is a required field OutpostId *string `location:"uri" locationName:"OutpostId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetOutpostInstanceTypesInput) GoString ¶
func (s GetOutpostInstanceTypesInput) GoString() string
GoString returns the string representation
func (*GetOutpostInstanceTypesInput) SetMaxResults ¶
func (s *GetOutpostInstanceTypesInput) SetMaxResults(v int64) *GetOutpostInstanceTypesInput
SetMaxResults sets the MaxResults field's value.
func (*GetOutpostInstanceTypesInput) SetNextToken ¶
func (s *GetOutpostInstanceTypesInput) SetNextToken(v string) *GetOutpostInstanceTypesInput
SetNextToken sets the NextToken field's value.
func (*GetOutpostInstanceTypesInput) SetOutpostId ¶
func (s *GetOutpostInstanceTypesInput) SetOutpostId(v string) *GetOutpostInstanceTypesInput
SetOutpostId sets the OutpostId field's value.
func (GetOutpostInstanceTypesInput) String ¶
func (s GetOutpostInstanceTypesInput) String() string
String returns the string representation
func (*GetOutpostInstanceTypesInput) Validate ¶
func (s *GetOutpostInstanceTypesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetOutpostInstanceTypesOutput ¶
type GetOutpostInstanceTypesOutput struct { // Information about the instance types. InstanceTypes []*InstanceTypeItem `type:"list"` // The pagination token. NextToken *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string `min:"1" type:"string"` // The ID of the Outpost. OutpostId *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (GetOutpostInstanceTypesOutput) GoString ¶
func (s GetOutpostInstanceTypesOutput) GoString() string
GoString returns the string representation
func (*GetOutpostInstanceTypesOutput) SetInstanceTypes ¶
func (s *GetOutpostInstanceTypesOutput) SetInstanceTypes(v []*InstanceTypeItem) *GetOutpostInstanceTypesOutput
SetInstanceTypes sets the InstanceTypes field's value.
func (*GetOutpostInstanceTypesOutput) SetNextToken ¶
func (s *GetOutpostInstanceTypesOutput) SetNextToken(v string) *GetOutpostInstanceTypesOutput
SetNextToken sets the NextToken field's value.
func (*GetOutpostInstanceTypesOutput) SetOutpostArn ¶
func (s *GetOutpostInstanceTypesOutput) SetOutpostArn(v string) *GetOutpostInstanceTypesOutput
SetOutpostArn sets the OutpostArn field's value.
func (*GetOutpostInstanceTypesOutput) SetOutpostId ¶
func (s *GetOutpostInstanceTypesOutput) SetOutpostId(v string) *GetOutpostInstanceTypesOutput
SetOutpostId sets the OutpostId field's value.
func (GetOutpostInstanceTypesOutput) String ¶
func (s GetOutpostInstanceTypesOutput) String() string
String returns the string representation
type GetOutpostOutput ¶
type GetOutpostOutput struct { // Information about an Outpost. Outpost *Outpost `type:"structure"` // contains filtered or unexported fields }
func (GetOutpostOutput) GoString ¶
func (s GetOutpostOutput) GoString() string
GoString returns the string representation
func (*GetOutpostOutput) SetOutpost ¶
func (s *GetOutpostOutput) SetOutpost(v *Outpost) *GetOutpostOutput
SetOutpost sets the Outpost field's value.
func (GetOutpostOutput) String ¶
func (s GetOutpostOutput) String() string
String returns the string representation
type InstanceTypeItem ¶
type InstanceTypeItem struct { // The instance type. InstanceType *string `type:"string"` // contains filtered or unexported fields }
Information about an instance type.
func (InstanceTypeItem) GoString ¶
func (s InstanceTypeItem) GoString() string
GoString returns the string representation
func (*InstanceTypeItem) SetInstanceType ¶
func (s *InstanceTypeItem) SetInstanceType(v string) *InstanceTypeItem
SetInstanceType sets the InstanceType field's value.
func (InstanceTypeItem) String ¶
func (s InstanceTypeItem) String() string
String returns the string representation
type ListOutpostsInput ¶
type ListOutpostsInput struct { // The maximum page size. MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"` // The pagination token. NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListOutpostsInput) GoString ¶
func (s ListOutpostsInput) GoString() string
GoString returns the string representation
func (*ListOutpostsInput) SetMaxResults ¶
func (s *ListOutpostsInput) SetMaxResults(v int64) *ListOutpostsInput
SetMaxResults sets the MaxResults field's value.
func (*ListOutpostsInput) SetNextToken ¶
func (s *ListOutpostsInput) SetNextToken(v string) *ListOutpostsInput
SetNextToken sets the NextToken field's value.
func (ListOutpostsInput) String ¶
func (s ListOutpostsInput) String() string
String returns the string representation
func (*ListOutpostsInput) Validate ¶
func (s *ListOutpostsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListOutpostsOutput ¶
type ListOutpostsOutput struct { // The pagination token. NextToken *string `min:"1" type:"string"` // Information about the Outposts. Outposts []*Outpost `type:"list"` // contains filtered or unexported fields }
func (ListOutpostsOutput) GoString ¶
func (s ListOutpostsOutput) GoString() string
GoString returns the string representation
func (*ListOutpostsOutput) SetNextToken ¶
func (s *ListOutpostsOutput) SetNextToken(v string) *ListOutpostsOutput
SetNextToken sets the NextToken field's value.
func (*ListOutpostsOutput) SetOutposts ¶
func (s *ListOutpostsOutput) SetOutposts(v []*Outpost) *ListOutpostsOutput
SetOutposts sets the Outposts field's value.
func (ListOutpostsOutput) String ¶
func (s ListOutpostsOutput) String() string
String returns the string representation
type ListSitesInput ¶
type ListSitesInput struct { // The maximum page size. MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"` // The pagination token. NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListSitesInput) GoString ¶
func (s ListSitesInput) GoString() string
GoString returns the string representation
func (*ListSitesInput) SetMaxResults ¶
func (s *ListSitesInput) SetMaxResults(v int64) *ListSitesInput
SetMaxResults sets the MaxResults field's value.
func (*ListSitesInput) SetNextToken ¶
func (s *ListSitesInput) SetNextToken(v string) *ListSitesInput
SetNextToken sets the NextToken field's value.
func (ListSitesInput) String ¶
func (s ListSitesInput) String() string
String returns the string representation
func (*ListSitesInput) Validate ¶
func (s *ListSitesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListSitesOutput ¶
type ListSitesOutput struct { // The pagination token. NextToken *string `min:"1" type:"string"` // Information about the sites. Sites []*Site `type:"list"` // contains filtered or unexported fields }
func (ListSitesOutput) GoString ¶
func (s ListSitesOutput) GoString() string
GoString returns the string representation
func (*ListSitesOutput) SetNextToken ¶
func (s *ListSitesOutput) SetNextToken(v string) *ListSitesOutput
SetNextToken sets the NextToken field's value.
func (*ListSitesOutput) SetSites ¶
func (s *ListSitesOutput) SetSites(v []*Site) *ListSitesOutput
SetSites sets the Sites field's value.
func (ListSitesOutput) String ¶
func (s ListSitesOutput) String() string
String returns the string representation
type Outpost ¶
type Outpost struct { // The Availability Zone. AvailabilityZone *string `min:"1" type:"string"` // The ID of the Availability Zone. AvailabilityZoneId *string `min:"1" type:"string"` // The Outpost description. Description *string `min:"1" type:"string"` // The life cycle status. LifeCycleStatus *string `type:"string"` // The name of the Outpost. Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of the Outpost. OutpostArn *string `min:"1" type:"string"` // The ID of the Outpost. OutpostId *string `min:"1" type:"string"` // The AWS account ID of the Outpost owner. OwnerId *string `min:"12" type:"string"` // The ID of the site. SiteId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Information about an Outpost.
func (*Outpost) SetAvailabilityZone ¶
SetAvailabilityZone sets the AvailabilityZone field's value.
func (*Outpost) SetAvailabilityZoneId ¶
SetAvailabilityZoneId sets the AvailabilityZoneId field's value.
func (*Outpost) SetDescription ¶
SetDescription sets the Description field's value.
func (*Outpost) SetLifeCycleStatus ¶
SetLifeCycleStatus sets the LifeCycleStatus field's value.
func (*Outpost) SetOutpostArn ¶
SetOutpostArn sets the OutpostArn field's value.
func (*Outpost) SetOutpostId ¶
SetOutpostId sets the OutpostId field's value.
func (*Outpost) SetOwnerId ¶
SetOwnerId sets the OwnerId field's value.
type Outposts ¶
Outposts provides the API operation methods for making requests to AWS Outposts. See this package's package overview docs for details on the service.
Outposts methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Outposts
New creates a new instance of the Outposts client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a Outposts client from just a session. svc := outposts.New(mySession) // Create a Outposts client with additional configuration svc := outposts.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Outposts) CreateOutpost ¶
func (c *Outposts) CreateOutpost(input *CreateOutpostInput) (*CreateOutpostOutput, error)
CreateOutpost API operation for AWS Outposts.
Creates an Outpost.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Outposts's API operation CreateOutpost for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" A parameter is not valid.
ErrCodeNotFoundException "NotFoundException" The specified request is not valid.
ErrCodeAccessDeniedException "AccessDeniedException" You do not have permission to perform this operation.
ErrCodeInternalServerException "InternalServerException" An internal error has occurred.
ErrCodeServiceQuotaExceededException "ServiceQuotaExceededException" You have exceeded a service quota.
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/CreateOutpost
func (*Outposts) CreateOutpostRequest ¶
func (c *Outposts) CreateOutpostRequest(input *CreateOutpostInput) (req *request.Request, output *CreateOutpostOutput)
CreateOutpostRequest generates a "aws/request.Request" representing the client's request for the CreateOutpost operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateOutpost for more information on using the CreateOutpost API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateOutpostRequest method. req, resp := client.CreateOutpostRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/CreateOutpost
func (*Outposts) CreateOutpostWithContext ¶
func (c *Outposts) CreateOutpostWithContext(ctx aws.Context, input *CreateOutpostInput, opts ...request.Option) (*CreateOutpostOutput, error)
CreateOutpostWithContext is the same as CreateOutpost with the addition of the ability to pass a context and additional request options.
See CreateOutpost for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Outposts) GetOutpost ¶
func (c *Outposts) GetOutpost(input *GetOutpostInput) (*GetOutpostOutput, error)
GetOutpost API operation for AWS Outposts.
Gets information about the specified Outpost.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Outposts's API operation GetOutpost for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" A parameter is not valid.
ErrCodeNotFoundException "NotFoundException" The specified request is not valid.
ErrCodeAccessDeniedException "AccessDeniedException" You do not have permission to perform this operation.
ErrCodeInternalServerException "InternalServerException" An internal error has occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpost
func (*Outposts) GetOutpostInstanceTypes ¶
func (c *Outposts) GetOutpostInstanceTypes(input *GetOutpostInstanceTypesInput) (*GetOutpostInstanceTypesOutput, error)
GetOutpostInstanceTypes API operation for AWS Outposts.
Lists the instance types for the specified Outpost.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Outposts's API operation GetOutpostInstanceTypes for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" A parameter is not valid.
ErrCodeNotFoundException "NotFoundException" The specified request is not valid.
ErrCodeAccessDeniedException "AccessDeniedException" You do not have permission to perform this operation.
ErrCodeInternalServerException "InternalServerException" An internal error has occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpostInstanceTypes
func (*Outposts) GetOutpostInstanceTypesRequest ¶
func (c *Outposts) GetOutpostInstanceTypesRequest(input *GetOutpostInstanceTypesInput) (req *request.Request, output *GetOutpostInstanceTypesOutput)
GetOutpostInstanceTypesRequest generates a "aws/request.Request" representing the client's request for the GetOutpostInstanceTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetOutpostInstanceTypes for more information on using the GetOutpostInstanceTypes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetOutpostInstanceTypesRequest method. req, resp := client.GetOutpostInstanceTypesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpostInstanceTypes
func (*Outposts) GetOutpostInstanceTypesWithContext ¶
func (c *Outposts) GetOutpostInstanceTypesWithContext(ctx aws.Context, input *GetOutpostInstanceTypesInput, opts ...request.Option) (*GetOutpostInstanceTypesOutput, error)
GetOutpostInstanceTypesWithContext is the same as GetOutpostInstanceTypes with the addition of the ability to pass a context and additional request options.
See GetOutpostInstanceTypes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Outposts) GetOutpostRequest ¶
func (c *Outposts) GetOutpostRequest(input *GetOutpostInput) (req *request.Request, output *GetOutpostOutput)
GetOutpostRequest generates a "aws/request.Request" representing the client's request for the GetOutpost operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetOutpost for more information on using the GetOutpost API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetOutpostRequest method. req, resp := client.GetOutpostRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpost
func (*Outposts) GetOutpostWithContext ¶
func (c *Outposts) GetOutpostWithContext(ctx aws.Context, input *GetOutpostInput, opts ...request.Option) (*GetOutpostOutput, error)
GetOutpostWithContext is the same as GetOutpost with the addition of the ability to pass a context and additional request options.
See GetOutpost for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Outposts) ListOutposts ¶
func (c *Outposts) ListOutposts(input *ListOutpostsInput) (*ListOutpostsOutput, error)
ListOutposts API operation for AWS Outposts.
List the Outposts for your AWS account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Outposts's API operation ListOutposts for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" A parameter is not valid.
ErrCodeAccessDeniedException "AccessDeniedException" You do not have permission to perform this operation.
ErrCodeInternalServerException "InternalServerException" An internal error has occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListOutposts
func (*Outposts) ListOutpostsPages ¶
func (c *Outposts) ListOutpostsPages(input *ListOutpostsInput, fn func(*ListOutpostsOutput, bool) bool) error
ListOutpostsPages iterates over the pages of a ListOutposts operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListOutposts method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListOutposts operation. pageNum := 0 err := client.ListOutpostsPages(params, func(page *outposts.ListOutpostsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*Outposts) ListOutpostsPagesWithContext ¶
func (c *Outposts) ListOutpostsPagesWithContext(ctx aws.Context, input *ListOutpostsInput, fn func(*ListOutpostsOutput, bool) bool, opts ...request.Option) error
ListOutpostsPagesWithContext same as ListOutpostsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Outposts) ListOutpostsRequest ¶
func (c *Outposts) ListOutpostsRequest(input *ListOutpostsInput) (req *request.Request, output *ListOutpostsOutput)
ListOutpostsRequest generates a "aws/request.Request" representing the client's request for the ListOutposts operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListOutposts for more information on using the ListOutposts API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListOutpostsRequest method. req, resp := client.ListOutpostsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListOutposts
func (*Outposts) ListOutpostsWithContext ¶
func (c *Outposts) ListOutpostsWithContext(ctx aws.Context, input *ListOutpostsInput, opts ...request.Option) (*ListOutpostsOutput, error)
ListOutpostsWithContext is the same as ListOutposts with the addition of the ability to pass a context and additional request options.
See ListOutposts for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Outposts) ListSites ¶
func (c *Outposts) ListSites(input *ListSitesInput) (*ListSitesOutput, error)
ListSites API operation for AWS Outposts.
Lists the sites for the specified AWS account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Outposts's API operation ListSites for usage and error information.
Returned Error Codes:
ErrCodeValidationException "ValidationException" A parameter is not valid.
ErrCodeAccessDeniedException "AccessDeniedException" You do not have permission to perform this operation.
ErrCodeInternalServerException "InternalServerException" An internal error has occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListSites
func (*Outposts) ListSitesPages ¶
func (c *Outposts) ListSitesPages(input *ListSitesInput, fn func(*ListSitesOutput, bool) bool) error
ListSitesPages iterates over the pages of a ListSites operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListSites method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListSites operation. pageNum := 0 err := client.ListSitesPages(params, func(page *outposts.ListSitesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*Outposts) ListSitesPagesWithContext ¶
func (c *Outposts) ListSitesPagesWithContext(ctx aws.Context, input *ListSitesInput, fn func(*ListSitesOutput, bool) bool, opts ...request.Option) error
ListSitesPagesWithContext same as ListSitesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Outposts) ListSitesRequest ¶
func (c *Outposts) ListSitesRequest(input *ListSitesInput) (req *request.Request, output *ListSitesOutput)
ListSitesRequest generates a "aws/request.Request" representing the client's request for the ListSites operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListSites for more information on using the ListSites API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListSitesRequest method. req, resp := client.ListSitesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListSites
func (*Outposts) ListSitesWithContext ¶
func (c *Outposts) ListSitesWithContext(ctx aws.Context, input *ListSitesInput, opts ...request.Option) (*ListSitesOutput, error)
ListSitesWithContext is the same as ListSites with the addition of the ability to pass a context and additional request options.
See ListSites for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type Site ¶
type Site struct { // The ID of the AWS account. AccountId *string `min:"12" type:"string"` // The description of the site. Description *string `min:"1" type:"string"` // The name of the site. Name *string `min:"1" type:"string"` // The ID of the site. SiteId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Information about a site.
func (*Site) SetAccountId ¶
SetAccountId sets the AccountId field's value.
func (*Site) SetDescription ¶
SetDescription sets the Description field's value.
Directories ¶
Path | Synopsis |
---|---|
Package outpostsiface provides an interface to enable mocking the AWS Outposts service client for testing your code.
|
Package outpostsiface provides an interface to enable mocking the AWS Outposts service client for testing your code. |