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

package elasticinference

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

Package elasticinference provides the client and types for making API requests to Amazon Elastic Inference.

Elastic Inference public APIs.

See https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25 for more information on this service.

See elasticinference package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticinference/

Using the Client

To contact Amazon Elastic Inference 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 Amazon Elastic Inference client ElasticInference for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/elasticinference/#New

Index

Package Files

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

Constants

const (

    // ErrCodeBadRequestException for service response error code
    // "BadRequestException".
    //
    // Raised when a malformed input has been provided to the API.
    ErrCodeBadRequestException = "BadRequestException"

    // ErrCodeInternalServerException for service response error code
    // "InternalServerException".
    //
    // Raised when an unexpected error occurred during request processing.
    ErrCodeInternalServerException = "InternalServerException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // Raised when the requested resource cannot be found.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
const (
    ServiceName = "Elastic Inference" // Name of service.
    EndpointsID = "elastic-inference" // ID to lookup a service endpoint with.
    ServiceID   = "Elastic Inference" // ServiceID is a unique identifier of a specific service.
)

Service information constants

type BadRequestException Uses

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

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Raised when a malformed input has been provided to the API.

func (*BadRequestException) Code Uses

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error Uses

func (s *BadRequestException) Error() string

func (BadRequestException) GoString Uses

func (s BadRequestException) GoString() string

GoString returns the string representation

func (*BadRequestException) Message Uses

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr Uses

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID Uses

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode Uses

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String Uses

func (s BadRequestException) String() string

String returns the string representation

type ElasticInference Uses

type ElasticInference struct {
    *client.Client
}

ElasticInference provides the API operation methods for making requests to Amazon Elastic Inference. See this package's package overview docs for details on the service.

ElasticInference 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) *ElasticInference

New creates a new instance of the ElasticInference 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 ElasticInference client from just a session.
svc := elasticinference.New(mySession)

// Create a ElasticInference client with additional configuration
svc := elasticinference.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ElasticInference) ListTagsForResource Uses

func (c *ElasticInference) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Elastic Inference.

Returns all tags of an Elastic Inference Accelerator.

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 Amazon Elastic Inference's API operation ListTagsForResource for usage and error information.

Returned Error Types:

* BadRequestException
Raised when a malformed input has been provided to the API.

* ResourceNotFoundException
Raised when the requested resource cannot be found.

* InternalServerException
Raised when an unexpected error occurred during request processing.

See also, https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25/ListTagsForResource

func (*ElasticInference) ListTagsForResourceRequest Uses

func (c *ElasticInference) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25/ListTagsForResource

func (*ElasticInference) ListTagsForResourceWithContext Uses

func (c *ElasticInference) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 (*ElasticInference) TagResource Uses

func (c *ElasticInference) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Elastic Inference.

Adds the specified tag(s) to an Elastic Inference Accelerator.

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 Amazon Elastic Inference's API operation TagResource for usage and error information.

Returned Error Types:

* BadRequestException
Raised when a malformed input has been provided to the API.

* ResourceNotFoundException
Raised when the requested resource cannot be found.

* InternalServerException
Raised when an unexpected error occurred during request processing.

See also, https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25/TagResource

func (*ElasticInference) TagResourceRequest Uses

func (c *ElasticInference) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25/TagResource

func (*ElasticInference) TagResourceWithContext Uses

func (c *ElasticInference) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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 (*ElasticInference) UntagResource Uses

func (c *ElasticInference) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Elastic Inference.

Removes the specified tag(s) from an Elastic Inference Accelerator.

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 Amazon Elastic Inference's API operation UntagResource for usage and error information.

Returned Error Types:

* BadRequestException
Raised when a malformed input has been provided to the API.

* ResourceNotFoundException
Raised when the requested resource cannot be found.

* InternalServerException
Raised when an unexpected error occurred during request processing.

See also, https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25/UntagResource

func (*ElasticInference) UntagResourceRequest Uses

func (c *ElasticInference) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/elastic-inference-2017-07-25/UntagResource

func (*ElasticInference) UntagResourceWithContext Uses

func (c *ElasticInference) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 InternalServerException Uses

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

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Raised when an unexpected error occurred during request processing.

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

type ListTagsForResourceInput struct {

    // The ARN of the Elastic Inference Accelerator to list the tags for.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString Uses

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn Uses

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String Uses

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate Uses

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput Uses

type ListTagsForResourceOutput struct {

    // The tags of the Elastic Inference Accelerator.
    Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString Uses

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags Uses

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String Uses

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ResourceNotFoundException Uses

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

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

Raised when the requested resource cannot be found.

func (*ResourceNotFoundException) Code Uses

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error Uses

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString Uses

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message Uses

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr Uses

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID Uses

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode Uses

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String Uses

func (s ResourceNotFoundException) String() string

String returns the string representation

type TagResourceInput Uses

type TagResourceInput struct {

    // The ARN of the Elastic Inference Accelerator to tag.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

    // The tags to add to the Elastic Inference Accelerator.
    //
    // Tags is a required field
    Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn Uses

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags Uses

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput Uses

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

func (TagResourceOutput) GoString Uses

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput Uses

type UntagResourceInput struct {

    // The ARN of the Elastic Inference Accelerator to untag.
    //
    // ResourceArn is a required field
    ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

    // The list of tags to remove from the Elastic Inference Accelerator.
    //
    // TagKeys is a required field
    TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) GoString Uses

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn Uses

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys Uses

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput Uses

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

func (UntagResourceOutput) GoString Uses

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

Directories

PathSynopsis
elasticinferenceifacePackage elasticinferenceiface provides an interface to enable mocking the Amazon Elastic Inference service client for testing your code.

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