outposts

package
v0.18.0 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2019 License: Apache-2.0 Imports: 6 Imported by: 18

Documentation

Overview

Package outposts provides the client and types for making API requests to 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 use 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 Outposts client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/outposts/#New

Index

Constants

View Source 
const (
	ServiceName = "Outposts" // Service's name
	ServiceID   = "Outposts" // Service's identifier
	EndpointsID = "outposts" // Service's Endpoint identifier
)
View Source 
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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Outposts. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := outposts.New(myConfig)

func (*Client) CreateOutpostRequest 

func (c *Client) CreateOutpostRequest(input *CreateOutpostInput) CreateOutpostRequest

CreateOutpostRequest returns a request value for making API operation for AWS Outposts.

Creates an Outpost. 

// Example sending a request using CreateOutpostRequest.
req := client.CreateOutpostRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetOutpostInstanceTypesRequest 

func (c *Client) GetOutpostInstanceTypesRequest(input *GetOutpostInstanceTypesInput) GetOutpostInstanceTypesRequest

GetOutpostInstanceTypesRequest returns a request value for making API operation for AWS Outposts.

Lists the instance types for the specified Outpost. 

// Example sending a request using GetOutpostInstanceTypesRequest.
req := client.GetOutpostInstanceTypesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetOutpostRequest 

func (c *Client) GetOutpostRequest(input *GetOutpostInput) GetOutpostRequest

GetOutpostRequest returns a request value for making API operation for AWS Outposts.

Gets information about the specified Outpost. 

// Example sending a request using GetOutpostRequest.
req := client.GetOutpostRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListOutpostsRequest 

func (c *Client) ListOutpostsRequest(input *ListOutpostsInput) ListOutpostsRequest

ListOutpostsRequest returns a request value for making API operation for AWS Outposts.

List the Outposts for your AWS account. 

// Example sending a request using ListOutpostsRequest.
req := client.ListOutpostsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListSitesRequest 

func (c *Client) ListSitesRequest(input *ListSitesInput) ListSitesRequest

ListSitesRequest returns a request value for making API operation for AWS Outposts.

Lists the sites for the specified AWS account. 

// Example sending a request using ListSitesRequest.
req := client.ListSitesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

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) MarshalFields 

func (s CreateOutpostInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s CreateOutpostOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateOutpostOutput) String 

func (s CreateOutpostOutput) String() string

String returns the string representation

type CreateOutpostRequest 

type CreateOutpostRequest struct {
	*aws.Request
	Input *CreateOutpostInput
	Copy  func(*CreateOutpostInput) CreateOutpostRequest
}

CreateOutpostRequest is the request type for the CreateOutpost API operation.

func (CreateOutpostRequest) Send 

func (r CreateOutpostRequest) Send(ctx context.Context) (*CreateOutpostResponse, error)

Send marshals and sends the CreateOutpost API request.

type CreateOutpostResponse 

type CreateOutpostResponse struct {
	*CreateOutpostOutput
	// contains filtered or unexported fields
}

CreateOutpostResponse is the response type for the CreateOutpost API operation.

func (*CreateOutpostResponse) SDKResponseMetdata 

func (r *CreateOutpostResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateOutpost request.

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) MarshalFields 

func (s GetOutpostInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s GetOutpostInstanceTypesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s GetOutpostInstanceTypesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetOutpostInstanceTypesOutput) String 

func (s GetOutpostInstanceTypesOutput) String() string

String returns the string representation

type GetOutpostInstanceTypesRequest 

type GetOutpostInstanceTypesRequest struct {
	*aws.Request
	Input *GetOutpostInstanceTypesInput
	Copy  func(*GetOutpostInstanceTypesInput) GetOutpostInstanceTypesRequest
}

GetOutpostInstanceTypesRequest is the request type for the GetOutpostInstanceTypes API operation.

func (GetOutpostInstanceTypesRequest) Send 

func (r GetOutpostInstanceTypesRequest) Send(ctx context.Context) (*GetOutpostInstanceTypesResponse, error)

Send marshals and sends the GetOutpostInstanceTypes API request.

type GetOutpostInstanceTypesResponse 

type GetOutpostInstanceTypesResponse struct {
	*GetOutpostInstanceTypesOutput
	// contains filtered or unexported fields
}

GetOutpostInstanceTypesResponse is the response type for the GetOutpostInstanceTypes API operation.

func (*GetOutpostInstanceTypesResponse) SDKResponseMetdata 

func (r *GetOutpostInstanceTypesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetOutpostInstanceTypes request.

type GetOutpostOutput 

type GetOutpostOutput struct {

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

func (GetOutpostOutput) MarshalFields 

func (s GetOutpostOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetOutpostOutput) String 

func (s GetOutpostOutput) String() string

String returns the string representation

type GetOutpostRequest 

type GetOutpostRequest struct {
	*aws.Request
	Input *GetOutpostInput
	Copy  func(*GetOutpostInput) GetOutpostRequest
}

GetOutpostRequest is the request type for the GetOutpost API operation.

func (GetOutpostRequest) Send 

func (r GetOutpostRequest) Send(ctx context.Context) (*GetOutpostResponse, error)

Send marshals and sends the GetOutpost API request.

type GetOutpostResponse 

type GetOutpostResponse struct {
	*GetOutpostOutput
	// contains filtered or unexported fields
}

GetOutpostResponse is the response type for the GetOutpost API operation.

func (*GetOutpostResponse) SDKResponseMetdata 

func (r *GetOutpostResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetOutpost request.

type InstanceTypeItem 

type InstanceTypeItem struct {

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

Information about an instance type.

func (InstanceTypeItem) MarshalFields 

func (s InstanceTypeItem) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s ListOutpostsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s ListOutpostsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListOutpostsOutput) String 

func (s ListOutpostsOutput) String() string

String returns the string representation

type ListOutpostsPaginator 

type ListOutpostsPaginator struct {
	aws.Pager
}

ListOutpostsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListOutpostsPaginator 

func NewListOutpostsPaginator(req ListOutpostsRequest) ListOutpostsPaginator

NewListOutpostsRequestPaginator returns a paginator for ListOutposts. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListOutpostsRequest(input)
p := outposts.NewListOutpostsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListOutpostsPaginator) CurrentPage 

func (p *ListOutpostsPaginator) CurrentPage() *ListOutpostsOutput

type ListOutpostsRequest 

type ListOutpostsRequest struct {
	*aws.Request
	Input *ListOutpostsInput
	Copy  func(*ListOutpostsInput) ListOutpostsRequest
}

ListOutpostsRequest is the request type for the ListOutposts API operation.

func (ListOutpostsRequest) Send 

func (r ListOutpostsRequest) Send(ctx context.Context) (*ListOutpostsResponse, error)

Send marshals and sends the ListOutposts API request.

type ListOutpostsResponse 

type ListOutpostsResponse struct {
	*ListOutpostsOutput
	// contains filtered or unexported fields
}

ListOutpostsResponse is the response type for the ListOutposts API operation.

func (*ListOutpostsResponse) SDKResponseMetdata 

func (r *ListOutpostsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListOutposts request.

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) MarshalFields 

func (s ListSitesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

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) MarshalFields 

func (s ListSitesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListSitesOutput) String 

func (s ListSitesOutput) String() string

String returns the string representation

type ListSitesPaginator 

type ListSitesPaginator struct {
	aws.Pager
}

ListSitesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListSitesPaginator 

func NewListSitesPaginator(req ListSitesRequest) ListSitesPaginator

NewListSitesRequestPaginator returns a paginator for ListSites. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListSitesRequest(input)
p := outposts.NewListSitesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListSitesPaginator) CurrentPage 

func (p *ListSitesPaginator) CurrentPage() *ListSitesOutput

type ListSitesRequest 

type ListSitesRequest struct {
	*aws.Request
	Input *ListSitesInput
	Copy  func(*ListSitesInput) ListSitesRequest
}

ListSitesRequest is the request type for the ListSites API operation.

func (ListSitesRequest) Send 

func (r ListSitesRequest) Send(ctx context.Context) (*ListSitesResponse, error)

Send marshals and sends the ListSites API request.

type ListSitesResponse 

type ListSitesResponse struct {
	*ListSitesOutput
	// contains filtered or unexported fields
}

ListSitesResponse is the response type for the ListSites API operation.

func (*ListSitesResponse) SDKResponseMetdata 

func (r *ListSitesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListSites request.

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) MarshalFields 

func (s Outpost) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Outpost) String 

func (s Outpost) String() string

String returns the string representation

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) MarshalFields 

func (s Site) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Site) String 

func (s Site) String() string

String returns the string representation

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.