aws-sdk-go: github.com/aws/aws-sdk-go/service/outposts Index | Files | Directories

package outposts

import "github.com/aws/aws-sdk-go/service/outposts"

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

Package Files

api.go doc.go errors.go service.go

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

type AccessDeniedException Uses

type AccessDeniedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

You do not have permission to perform this operation.

func (*AccessDeniedException) Code Uses

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error Uses

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString Uses

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message Uses

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr Uses

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID Uses

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode Uses

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String Uses

func (s AccessDeniedException) String() string

String returns the string representation

type CreateOutpostInput Uses

type CreateOutpostInput struct {

    // The Availability Zone.
    //
    // You must specify AvailabilityZone or AvailabilityZoneId.
    AvailabilityZone *string `min:"1" type:"string"`

    // The ID of the Availability Zone.
    //
    // You must specify AvailabilityZone or AvailabilityZoneId.
    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 Uses

func (s CreateOutpostInput) GoString() string

GoString returns the string representation

func (*CreateOutpostInput) SetAvailabilityZone Uses

func (s *CreateOutpostInput) SetAvailabilityZone(v string) *CreateOutpostInput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateOutpostInput) SetAvailabilityZoneId Uses

func (s *CreateOutpostInput) SetAvailabilityZoneId(v string) *CreateOutpostInput

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*CreateOutpostInput) SetDescription Uses

func (s *CreateOutpostInput) SetDescription(v string) *CreateOutpostInput

SetDescription sets the Description field's value.

func (*CreateOutpostInput) SetName Uses

func (s *CreateOutpostInput) SetName(v string) *CreateOutpostInput

SetName sets the Name field's value.

func (*CreateOutpostInput) SetSiteId Uses

func (s *CreateOutpostInput) SetSiteId(v string) *CreateOutpostInput

SetSiteId sets the SiteId field's value.

func (CreateOutpostInput) String Uses

func (s CreateOutpostInput) String() string

String returns the string representation

func (*CreateOutpostInput) Validate Uses

func (s *CreateOutpostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateOutpostOutput Uses

type CreateOutpostOutput struct {

    // Information about an Outpost.
    Outpost *Outpost `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateOutpostOutput) GoString Uses

func (s CreateOutpostOutput) GoString() string

GoString returns the string representation

func (*CreateOutpostOutput) SetOutpost Uses

func (s *CreateOutpostOutput) SetOutpost(v *Outpost) *CreateOutpostOutput

SetOutpost sets the Outpost field's value.

func (CreateOutpostOutput) String Uses

func (s CreateOutpostOutput) String() string

String returns the string representation

type DeleteOutpostInput Uses

type DeleteOutpostInput 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 (DeleteOutpostInput) GoString Uses

func (s DeleteOutpostInput) GoString() string

GoString returns the string representation

func (*DeleteOutpostInput) SetOutpostId Uses

func (s *DeleteOutpostInput) SetOutpostId(v string) *DeleteOutpostInput

SetOutpostId sets the OutpostId field's value.

func (DeleteOutpostInput) String Uses

func (s DeleteOutpostInput) String() string

String returns the string representation

func (*DeleteOutpostInput) Validate Uses

func (s *DeleteOutpostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteOutpostOutput Uses

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

func (DeleteOutpostOutput) GoString Uses

func (s DeleteOutpostOutput) GoString() string

GoString returns the string representation

func (DeleteOutpostOutput) String Uses

func (s DeleteOutpostOutput) String() string

String returns the string representation

type DeleteSiteInput Uses

type DeleteSiteInput struct {

    // The ID of the site.
    //
    // SiteId is a required field
    SiteId *string `location:"uri" locationName:"SiteId" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteSiteInput) GoString Uses

func (s DeleteSiteInput) GoString() string

GoString returns the string representation

func (*DeleteSiteInput) SetSiteId Uses

func (s *DeleteSiteInput) SetSiteId(v string) *DeleteSiteInput

SetSiteId sets the SiteId field's value.

func (DeleteSiteInput) String Uses

func (s DeleteSiteInput) String() string

String returns the string representation

func (*DeleteSiteInput) Validate Uses

func (s *DeleteSiteInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSiteOutput Uses

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

func (DeleteSiteOutput) GoString Uses

func (s DeleteSiteOutput) GoString() string

GoString returns the string representation

func (DeleteSiteOutput) String Uses

func (s DeleteSiteOutput) String() string

String returns the string representation

type GetOutpostInput Uses

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 Uses

func (s GetOutpostInput) GoString() string

GoString returns the string representation

func (*GetOutpostInput) SetOutpostId Uses

func (s *GetOutpostInput) SetOutpostId(v string) *GetOutpostInput

SetOutpostId sets the OutpostId field's value.

func (GetOutpostInput) String Uses

func (s GetOutpostInput) String() string

String returns the string representation

func (*GetOutpostInput) Validate Uses

func (s *GetOutpostInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOutpostInstanceTypesInput Uses

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 Uses

func (s GetOutpostInstanceTypesInput) GoString() string

GoString returns the string representation

func (*GetOutpostInstanceTypesInput) SetMaxResults Uses

func (s *GetOutpostInstanceTypesInput) SetMaxResults(v int64) *GetOutpostInstanceTypesInput

SetMaxResults sets the MaxResults field's value.

func (*GetOutpostInstanceTypesInput) SetNextToken Uses

func (s *GetOutpostInstanceTypesInput) SetNextToken(v string) *GetOutpostInstanceTypesInput

SetNextToken sets the NextToken field's value.

func (*GetOutpostInstanceTypesInput) SetOutpostId Uses

func (s *GetOutpostInstanceTypesInput) SetOutpostId(v string) *GetOutpostInstanceTypesInput

SetOutpostId sets the OutpostId field's value.

func (GetOutpostInstanceTypesInput) String Uses

func (s GetOutpostInstanceTypesInput) String() string

String returns the string representation

func (*GetOutpostInstanceTypesInput) Validate Uses

func (s *GetOutpostInstanceTypesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOutpostInstanceTypesOutput Uses

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 Uses

func (s GetOutpostInstanceTypesOutput) GoString() string

GoString returns the string representation

func (*GetOutpostInstanceTypesOutput) SetInstanceTypes Uses

func (s *GetOutpostInstanceTypesOutput) SetInstanceTypes(v []*InstanceTypeItem) *GetOutpostInstanceTypesOutput

SetInstanceTypes sets the InstanceTypes field's value.

func (*GetOutpostInstanceTypesOutput) SetNextToken Uses

func (s *GetOutpostInstanceTypesOutput) SetNextToken(v string) *GetOutpostInstanceTypesOutput

SetNextToken sets the NextToken field's value.

func (*GetOutpostInstanceTypesOutput) SetOutpostArn Uses

func (s *GetOutpostInstanceTypesOutput) SetOutpostArn(v string) *GetOutpostInstanceTypesOutput

SetOutpostArn sets the OutpostArn field's value.

func (*GetOutpostInstanceTypesOutput) SetOutpostId Uses

func (s *GetOutpostInstanceTypesOutput) SetOutpostId(v string) *GetOutpostInstanceTypesOutput

SetOutpostId sets the OutpostId field's value.

func (GetOutpostInstanceTypesOutput) String Uses

func (s GetOutpostInstanceTypesOutput) String() string

String returns the string representation

type GetOutpostOutput Uses

type GetOutpostOutput struct {

    // Information about an Outpost.
    Outpost *Outpost `type:"structure"`
    // contains filtered or unexported fields
}

func (GetOutpostOutput) GoString Uses

func (s GetOutpostOutput) GoString() string

GoString returns the string representation

func (*GetOutpostOutput) SetOutpost Uses

func (s *GetOutpostOutput) SetOutpost(v *Outpost) *GetOutpostOutput

SetOutpost sets the Outpost field's value.

func (GetOutpostOutput) String Uses

func (s GetOutpostOutput) String() string

String returns the string representation

type InstanceTypeItem Uses

type InstanceTypeItem struct {

    // The instance type.
    InstanceType *string `type:"string"`
    // contains filtered or unexported fields
}

Information about an instance type.

func (InstanceTypeItem) GoString Uses

func (s InstanceTypeItem) GoString() string

GoString returns the string representation

func (*InstanceTypeItem) SetInstanceType Uses

func (s *InstanceTypeItem) SetInstanceType(v string) *InstanceTypeItem

SetInstanceType sets the InstanceType field's value.

func (InstanceTypeItem) String Uses

func (s InstanceTypeItem) String() string

String returns the string representation

type InternalServerException Uses

type InternalServerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

An internal error has occurred.

func (*InternalServerException) Code Uses

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error Uses

func (s *InternalServerException) Error() string

func (InternalServerException) GoString Uses

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message Uses

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr Uses

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID Uses

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode Uses

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String Uses

func (s InternalServerException) String() string

String returns the string representation

type ListOutpostsInput Uses

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 Uses

func (s ListOutpostsInput) GoString() string

GoString returns the string representation

func (*ListOutpostsInput) SetMaxResults Uses

func (s *ListOutpostsInput) SetMaxResults(v int64) *ListOutpostsInput

SetMaxResults sets the MaxResults field's value.

func (*ListOutpostsInput) SetNextToken Uses

func (s *ListOutpostsInput) SetNextToken(v string) *ListOutpostsInput

SetNextToken sets the NextToken field's value.

func (ListOutpostsInput) String Uses

func (s ListOutpostsInput) String() string

String returns the string representation

func (*ListOutpostsInput) Validate Uses

func (s *ListOutpostsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListOutpostsOutput Uses

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 Uses

func (s ListOutpostsOutput) GoString() string

GoString returns the string representation

func (*ListOutpostsOutput) SetNextToken Uses

func (s *ListOutpostsOutput) SetNextToken(v string) *ListOutpostsOutput

SetNextToken sets the NextToken field's value.

func (*ListOutpostsOutput) SetOutposts Uses

func (s *ListOutpostsOutput) SetOutposts(v []*Outpost) *ListOutpostsOutput

SetOutposts sets the Outposts field's value.

func (ListOutpostsOutput) String Uses

func (s ListOutpostsOutput) String() string

String returns the string representation

type ListSitesInput Uses

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 Uses

func (s ListSitesInput) GoString() string

GoString returns the string representation

func (*ListSitesInput) SetMaxResults Uses

func (s *ListSitesInput) SetMaxResults(v int64) *ListSitesInput

SetMaxResults sets the MaxResults field's value.

func (*ListSitesInput) SetNextToken Uses

func (s *ListSitesInput) SetNextToken(v string) *ListSitesInput

SetNextToken sets the NextToken field's value.

func (ListSitesInput) String Uses

func (s ListSitesInput) String() string

String returns the string representation

func (*ListSitesInput) Validate Uses

func (s *ListSitesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSitesOutput Uses

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 Uses

func (s ListSitesOutput) GoString() string

GoString returns the string representation

func (*ListSitesOutput) SetNextToken Uses

func (s *ListSitesOutput) SetNextToken(v string) *ListSitesOutput

SetNextToken sets the NextToken field's value.

func (*ListSitesOutput) SetSites Uses

func (s *ListSitesOutput) SetSites(v []*Site) *ListSitesOutput

SetSites sets the Sites field's value.

func (ListSitesOutput) String Uses

func (s ListSitesOutput) String() string

String returns the string representation

type NotFoundException Uses

type NotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

The specified request is not valid.

func (*NotFoundException) Code Uses

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error Uses

func (s *NotFoundException) Error() string

func (NotFoundException) GoString Uses

func (s NotFoundException) GoString() string

GoString returns the string representation

func (*NotFoundException) Message Uses

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr Uses

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID Uses

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode Uses

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String Uses

func (s NotFoundException) String() string

String returns the string representation

type Outpost Uses

type Outpost struct {

    // The Availability Zone.
    //
    // You must specify AvailabilityZone or AvailabilityZoneId.
    AvailabilityZone *string `min:"1" type:"string"`

    // The ID of the Availability Zone.
    //
    // You must specify AvailabilityZone or AvailabilityZoneId.
    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) GoString Uses

func (s Outpost) GoString() string

GoString returns the string representation

func (*Outpost) SetAvailabilityZone Uses

func (s *Outpost) SetAvailabilityZone(v string) *Outpost

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*Outpost) SetAvailabilityZoneId Uses

func (s *Outpost) SetAvailabilityZoneId(v string) *Outpost

SetAvailabilityZoneId sets the AvailabilityZoneId field's value.

func (*Outpost) SetDescription Uses

func (s *Outpost) SetDescription(v string) *Outpost

SetDescription sets the Description field's value.

func (*Outpost) SetLifeCycleStatus Uses

func (s *Outpost) SetLifeCycleStatus(v string) *Outpost

SetLifeCycleStatus sets the LifeCycleStatus field's value.

func (*Outpost) SetName Uses

func (s *Outpost) SetName(v string) *Outpost

SetName sets the Name field's value.

func (*Outpost) SetOutpostArn Uses

func (s *Outpost) SetOutpostArn(v string) *Outpost

SetOutpostArn sets the OutpostArn field's value.

func (*Outpost) SetOutpostId Uses

func (s *Outpost) SetOutpostId(v string) *Outpost

SetOutpostId sets the OutpostId field's value.

func (*Outpost) SetOwnerId Uses

func (s *Outpost) SetOwnerId(v string) *Outpost

SetOwnerId sets the OwnerId field's value.

func (*Outpost) SetSiteId Uses

func (s *Outpost) SetSiteId(v string) *Outpost

SetSiteId sets the SiteId field's value.

func (Outpost) String Uses

func (s Outpost) String() string

String returns the string representation

type Outposts Uses

type Outposts struct {
    *client.Client
}

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 Uses

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 Uses

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 Types:

* ValidationException
A parameter is not valid.

* NotFoundException
The specified request is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

* ServiceQuotaExceededException
You have exceeded a service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/CreateOutpost

func (*Outposts) CreateOutpostRequest Uses

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 Uses

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) DeleteOutpost Uses

func (c *Outposts) DeleteOutpost(input *DeleteOutpostInput) (*DeleteOutpostOutput, error)

DeleteOutpost API operation for AWS Outposts.

Deletes the 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 DeleteOutpost for usage and error information.

Returned Error Types:

* ValidationException
A parameter is not valid.

* NotFoundException
The specified request is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/DeleteOutpost

func (*Outposts) DeleteOutpostRequest Uses

func (c *Outposts) DeleteOutpostRequest(input *DeleteOutpostInput) (req *request.Request, output *DeleteOutpostOutput)

DeleteOutpostRequest generates a "aws/request.Request" representing the client's request for the DeleteOutpost 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 DeleteOutpost for more information on using the DeleteOutpost 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 DeleteOutpostRequest method.
req, resp := client.DeleteOutpostRequest(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/DeleteOutpost

func (*Outposts) DeleteOutpostWithContext Uses

func (c *Outposts) DeleteOutpostWithContext(ctx aws.Context, input *DeleteOutpostInput, opts ...request.Option) (*DeleteOutpostOutput, error)

DeleteOutpostWithContext is the same as DeleteOutpost with the addition of the ability to pass a context and additional request options.

See DeleteOutpost 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) DeleteSite Uses

func (c *Outposts) DeleteSite(input *DeleteSiteInput) (*DeleteSiteOutput, error)

DeleteSite API operation for AWS Outposts.

Deletes the site.

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 DeleteSite for usage and error information.

Returned Error Types:

* ValidationException
A parameter is not valid.

* NotFoundException
The specified request is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/DeleteSite

func (*Outposts) DeleteSiteRequest Uses

func (c *Outposts) DeleteSiteRequest(input *DeleteSiteInput) (req *request.Request, output *DeleteSiteOutput)

DeleteSiteRequest generates a "aws/request.Request" representing the client's request for the DeleteSite 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 DeleteSite for more information on using the DeleteSite 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 DeleteSiteRequest method.
req, resp := client.DeleteSiteRequest(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/DeleteSite

func (*Outposts) DeleteSiteWithContext Uses

func (c *Outposts) DeleteSiteWithContext(ctx aws.Context, input *DeleteSiteInput, opts ...request.Option) (*DeleteSiteOutput, error)

DeleteSiteWithContext is the same as DeleteSite with the addition of the ability to pass a context and additional request options.

See DeleteSite 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 Uses

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 Types:

* ValidationException
A parameter is not valid.

* NotFoundException
The specified request is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpost

func (*Outposts) GetOutpostInstanceTypes Uses

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 Types:

* ValidationException
A parameter is not valid.

* NotFoundException
The specified request is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/GetOutpostInstanceTypes

func (*Outposts) GetOutpostInstanceTypesRequest Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Types:

* ValidationException
A parameter is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListOutposts

func (*Outposts) ListOutpostsPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Types:

* ValidationException
A parameter is not valid.

* AccessDeniedException
You do not have permission to perform this operation.

* InternalServerException
An internal error has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/outposts-2019-12-03/ListSites

func (*Outposts) ListSitesPages Uses

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 Uses

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 Uses

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 Uses

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 ServiceQuotaExceededException Uses

type ServiceQuotaExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

You have exceeded a service quota.

func (*ServiceQuotaExceededException) Code Uses

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error Uses

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString Uses

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message Uses

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr Uses

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID Uses

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode Uses

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String Uses

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type Site Uses

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) GoString Uses

func (s Site) GoString() string

GoString returns the string representation

func (*Site) SetAccountId Uses

func (s *Site) SetAccountId(v string) *Site

SetAccountId sets the AccountId field's value.

func (*Site) SetDescription Uses

func (s *Site) SetDescription(v string) *Site

SetDescription sets the Description field's value.

func (*Site) SetName Uses

func (s *Site) SetName(v string) *Site

SetName sets the Name field's value.

func (*Site) SetSiteId Uses

func (s *Site) SetSiteId(v string) *Site

SetSiteId sets the SiteId field's value.

func (Site) String Uses

func (s Site) String() string

String returns the string representation

type ValidationException Uses

type ValidationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" min:"1" type:"string"`
    // contains filtered or unexported fields
}

A parameter is not valid.

func (*ValidationException) Code Uses

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error Uses

func (s *ValidationException) Error() string

func (ValidationException) GoString Uses

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message Uses

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr Uses

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID Uses

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode Uses

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String Uses

func (s ValidationException) String() string

String returns the string representation

Directories

PathSynopsis
outpostsifacePackage outpostsiface provides an interface to enable mocking the AWS Outposts service client for testing your code.

Package outposts imports 9 packages (graph) and is imported by 7 packages. Updated 2020-04-04. Refresh now. Tools for package owners.