elasticinference

package
v0.0.0-...-c570f4e Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

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

Elastic Inference public APIs.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

Constants

View Source
const (
	// LocationTypeRegion is a LocationType enum value
	LocationTypeRegion = "region"

	// LocationTypeAvailabilityZone is a LocationType enum value
	LocationTypeAvailabilityZone = "availability-zone"

	// LocationTypeAvailabilityZoneId is a LocationType enum value
	LocationTypeAvailabilityZoneId = "availability-zone-id"
)
View Source
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"
)
View Source
const (
	ServiceName = "Elastic Inference"     // Name of service.
	EndpointsID = "api.elastic-inference" // ID to lookup a service endpoint with.
	ServiceID   = "Elastic Inference"     // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func LocationType_Values

func LocationType_Values() []string

LocationType_Values returns all elements of the LocationType enum

Types

type AcceleratorType

type AcceleratorType struct {

	// The name of the Elastic Inference Accelerator type.
	AcceleratorTypeName *string `locationName:"acceleratorTypeName" min:"1" type:"string"`

	// The memory information of the Elastic Inference Accelerator type.
	MemoryInfo *MemoryInfo `locationName:"memoryInfo" type:"structure"`

	// The throughput information of the Elastic Inference Accelerator type.
	ThroughputInfo []*KeyValuePair `locationName:"throughputInfo" type:"list"`
	// contains filtered or unexported fields
}

The details of an Elastic Inference Accelerator type.

func (AcceleratorType) GoString

func (s AcceleratorType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceleratorType) SetAcceleratorTypeName

func (s *AcceleratorType) SetAcceleratorTypeName(v string) *AcceleratorType

SetAcceleratorTypeName sets the AcceleratorTypeName field's value.

func (*AcceleratorType) SetMemoryInfo

func (s *AcceleratorType) SetMemoryInfo(v *MemoryInfo) *AcceleratorType

SetMemoryInfo sets the MemoryInfo field's value.

func (*AcceleratorType) SetThroughputInfo

func (s *AcceleratorType) SetThroughputInfo(v []*KeyValuePair) *AcceleratorType

SetThroughputInfo sets the ThroughputInfo field's value.

func (AcceleratorType) String

func (s AcceleratorType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AcceleratorTypeOffering

type AcceleratorTypeOffering struct {

	// The name of the Elastic Inference Accelerator type.
	AcceleratorType *string `locationName:"acceleratorType" min:"1" type:"string"`

	// The location for the offering. It will return either the region, availability
	// zone or availability zone id for the offering depending on the locationType
	// value.
	Location *string `locationName:"location" min:"1" type:"string"`

	// The location type for the offering. It can assume the following values: region:
	// defines that the offering is at the regional level. availability-zone: defines
	// that the offering is at the availability zone level. availability-zone-id:
	// defines that the offering is at the availability zone level, defined by the
	// availability zone id.
	LocationType *string `locationName:"locationType" min:"1" type:"string" enum:"LocationType"`
	// contains filtered or unexported fields
}

The offering for an Elastic Inference Accelerator type.

func (AcceleratorTypeOffering) GoString

func (s AcceleratorTypeOffering) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AcceleratorTypeOffering) SetAcceleratorType

func (s *AcceleratorTypeOffering) SetAcceleratorType(v string) *AcceleratorTypeOffering

SetAcceleratorType sets the AcceleratorType field's value.

func (*AcceleratorTypeOffering) SetLocation

SetLocation sets the Location field's value.

func (*AcceleratorTypeOffering) SetLocationType

SetLocationType sets the LocationType field's value.

func (AcceleratorTypeOffering) String

func (s AcceleratorTypeOffering) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BadRequestException

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

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error

func (s *BadRequestException) Error() string

func (BadRequestException) GoString

func (s BadRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BadRequestException) Message

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String

func (s BadRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAcceleratorOfferingsInput

type DescribeAcceleratorOfferingsInput struct {

	// The list of accelerator types to describe.
	AcceleratorTypes []*string `locationName:"acceleratorTypes" type:"list"`

	// The location type that you want to describe accelerator type offerings for.
	// It can assume the following values: region: will return the accelerator type
	// offering at the regional level. availability-zone: will return the accelerator
	// type offering at the availability zone level. availability-zone-id: will
	// return the accelerator type offering at the availability zone level returning
	// the availability zone id.
	//
	// LocationType is a required field
	LocationType *string `locationName:"locationType" min:"1" type:"string" required:"true" enum:"LocationType"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorOfferingsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorOfferingsInput) SetAcceleratorTypes

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (*DescribeAcceleratorOfferingsInput) SetLocationType

SetLocationType sets the LocationType field's value.

func (DescribeAcceleratorOfferingsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorOfferingsInput) Validate

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

type DescribeAcceleratorOfferingsOutput

type DescribeAcceleratorOfferingsOutput struct {

	// The list of accelerator type offerings for a specific location.
	AcceleratorTypeOfferings []*AcceleratorTypeOffering `locationName:"acceleratorTypeOfferings" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorOfferingsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorOfferingsOutput) SetAcceleratorTypeOfferings

SetAcceleratorTypeOfferings sets the AcceleratorTypeOfferings field's value.

func (DescribeAcceleratorOfferingsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAcceleratorTypesInput

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

func (DescribeAcceleratorTypesInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAcceleratorTypesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAcceleratorTypesOutput

type DescribeAcceleratorTypesOutput struct {

	// The available accelerator types.
	AcceleratorTypes []*AcceleratorType `locationName:"acceleratorTypes" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorTypesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorTypesOutput) SetAcceleratorTypes

SetAcceleratorTypes sets the AcceleratorTypes field's value.

func (DescribeAcceleratorTypesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAcceleratorsInput

type DescribeAcceleratorsInput struct {

	// The IDs of the accelerators to describe.
	AcceleratorIds []*string `locationName:"acceleratorIds" type:"list"`

	// One or more filters. Filter names and values are case-sensitive. Valid filter
	// names are: accelerator-types: can provide a list of accelerator type names
	// to filter for. instance-id: can provide a list of EC2 instance ids to filter
	// for.
	Filters []*Filter `locationName:"filters" type:"list"`

	// The total number of items to return in the command's output. If the total
	// number of items available is more than the value specified, a NextToken is
	// provided in the command's output. To resume pagination, provide the NextToken
	// value in the starting-token argument of a subsequent command. Do not use
	// the NextToken response element directly outside of the AWS CLI.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorsInput) GoString

func (s DescribeAcceleratorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorsInput) SetAcceleratorIds

func (s *DescribeAcceleratorsInput) SetAcceleratorIds(v []*string) *DescribeAcceleratorsInput

SetAcceleratorIds sets the AcceleratorIds field's value.

func (*DescribeAcceleratorsInput) SetFilters

SetFilters sets the Filters field's value.

func (*DescribeAcceleratorsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*DescribeAcceleratorsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeAcceleratorsInput) String

func (s DescribeAcceleratorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorsInput) Validate

func (s *DescribeAcceleratorsInput) Validate() error

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

type DescribeAcceleratorsOutput

type DescribeAcceleratorsOutput struct {

	// The details of the Elastic Inference Accelerators.
	AcceleratorSet []*ElasticInferenceAccelerator `locationName:"acceleratorSet" type:"list"`

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorsOutput) GoString

func (s DescribeAcceleratorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAcceleratorsOutput) SetAcceleratorSet

SetAcceleratorSet sets the AcceleratorSet field's value.

func (*DescribeAcceleratorsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (DescribeAcceleratorsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ElasticInference

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

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

DescribeAcceleratorOfferings API operation for Amazon Elastic Inference.

Describes the locations in which a given accelerator type or set of types is present in a given region.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

func (*ElasticInference) DescribeAcceleratorOfferingsRequest

func (c *ElasticInference) DescribeAcceleratorOfferingsRequest(input *DescribeAcceleratorOfferingsInput) (req *request.Request, output *DescribeAcceleratorOfferingsOutput)

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

func (*ElasticInference) DescribeAcceleratorOfferingsWithContext

func (c *ElasticInference) DescribeAcceleratorOfferingsWithContext(ctx aws.Context, input *DescribeAcceleratorOfferingsInput, opts ...request.Option) (*DescribeAcceleratorOfferingsOutput, error)

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

See DescribeAcceleratorOfferings 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) DescribeAcceleratorTypes

DescribeAcceleratorTypes API operation for Amazon Elastic Inference.

Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

Returned Error Types:

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

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

func (*ElasticInference) DescribeAcceleratorTypesRequest

func (c *ElasticInference) DescribeAcceleratorTypesRequest(input *DescribeAcceleratorTypesInput) (req *request.Request, output *DescribeAcceleratorTypesOutput)

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

func (*ElasticInference) DescribeAcceleratorTypesWithContext

func (c *ElasticInference) DescribeAcceleratorTypesWithContext(ctx aws.Context, input *DescribeAcceleratorTypesInput, opts ...request.Option) (*DescribeAcceleratorTypesOutput, error)

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

See DescribeAcceleratorTypes 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) DescribeAccelerators

func (c *ElasticInference) DescribeAccelerators(input *DescribeAcceleratorsInput) (*DescribeAcceleratorsOutput, error)

DescribeAccelerators API operation for Amazon Elastic Inference.

Describes information over a provided set of accelerators belonging to an account.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

func (*ElasticInference) DescribeAcceleratorsPages

func (c *ElasticInference) DescribeAcceleratorsPages(input *DescribeAcceleratorsInput, fn func(*DescribeAcceleratorsOutput, bool) bool) error

DescribeAcceleratorsPages iterates over the pages of a DescribeAccelerators operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeAccelerators 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 DescribeAccelerators operation.
pageNum := 0
err := client.DescribeAcceleratorsPages(params,
    func(page *elasticinference.DescribeAcceleratorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ElasticInference) DescribeAcceleratorsPagesWithContext

func (c *ElasticInference) DescribeAcceleratorsPagesWithContext(ctx aws.Context, input *DescribeAcceleratorsInput, fn func(*DescribeAcceleratorsOutput, bool) bool, opts ...request.Option) error

DescribeAcceleratorsPagesWithContext same as DescribeAcceleratorsPages 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 (*ElasticInference) DescribeAcceleratorsRequest

func (c *ElasticInference) DescribeAcceleratorsRequest(input *DescribeAcceleratorsInput) (req *request.Request, output *DescribeAcceleratorsOutput)

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

func (*ElasticInference) DescribeAcceleratorsWithContext

func (c *ElasticInference) DescribeAcceleratorsWithContext(ctx aws.Context, input *DescribeAcceleratorsInput, opts ...request.Option) (*DescribeAcceleratorsOutput, error)

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

See DescribeAccelerators 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) ListTagsForResource

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

ListTagsForResource API operation for Amazon Elastic Inference.

Returns all tags of an Elastic Inference Accelerator.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

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

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

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

TagResource API operation for Amazon Elastic Inference.

Adds the specified tags to an Elastic Inference Accelerator.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

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

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

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

UntagResource API operation for Amazon Elastic Inference.

Removes the specified tags from an Elastic Inference Accelerator.

February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

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

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

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 ElasticInferenceAccelerator

type ElasticInferenceAccelerator struct {

	// The health of the Elastic Inference Accelerator.
	AcceleratorHealth *ElasticInferenceAcceleratorHealth `locationName:"acceleratorHealth" type:"structure"`

	// The ID of the Elastic Inference Accelerator.
	AcceleratorId *string `locationName:"acceleratorId" min:"1" type:"string"`

	// The type of the Elastic Inference Accelerator.
	AcceleratorType *string `locationName:"acceleratorType" min:"1" type:"string"`

	// The ARN of the resource that the Elastic Inference Accelerator is attached
	// to.
	AttachedResource *string `locationName:"attachedResource" min:"1" type:"string"`

	// The availability zone where the Elastic Inference Accelerator is present.
	AvailabilityZone *string `locationName:"availabilityZone" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The details of an Elastic Inference Accelerator.

func (ElasticInferenceAccelerator) GoString

func (s ElasticInferenceAccelerator) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ElasticInferenceAccelerator) SetAcceleratorHealth

SetAcceleratorHealth sets the AcceleratorHealth field's value.

func (*ElasticInferenceAccelerator) SetAcceleratorId

SetAcceleratorId sets the AcceleratorId field's value.

func (*ElasticInferenceAccelerator) SetAcceleratorType

SetAcceleratorType sets the AcceleratorType field's value.

func (*ElasticInferenceAccelerator) SetAttachedResource

SetAttachedResource sets the AttachedResource field's value.

func (*ElasticInferenceAccelerator) SetAvailabilityZone

SetAvailabilityZone sets the AvailabilityZone field's value.

func (ElasticInferenceAccelerator) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ElasticInferenceAcceleratorHealth

type ElasticInferenceAcceleratorHealth struct {

	// The health status of the Elastic Inference Accelerator.
	Status *string `locationName:"status" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The health details of an Elastic Inference Accelerator.

func (ElasticInferenceAcceleratorHealth) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ElasticInferenceAcceleratorHealth) SetStatus

SetStatus sets the Status field's value.

func (ElasticInferenceAcceleratorHealth) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Filter

type Filter struct {

	// The filter name for the Elastic Inference Accelerator list. It can assume
	// the following values: accelerator-type: the type of Elastic Inference Accelerator
	// to filter for. instance-id: an EC2 instance id to filter for.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The values for the filter of the Elastic Inference Accelerator list.
	Values []*string `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

A filter expression for the Elastic Inference Accelerator list.

func (Filter) GoString

func (s Filter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) SetName

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

SetName sets the Name field's value.

func (*Filter) SetValues

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String

func (s Filter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Filter) Validate

func (s *Filter) Validate() error

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

type InternalServerException

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

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KeyValuePair

type KeyValuePair struct {

	// The throughput value of the Elastic Inference Accelerator type. It can assume
	// the following values: TFLOPS16bit: the throughput expressed in 16bit TeraFLOPS.
	// TFLOPS32bit: the throughput expressed in 32bit TeraFLOPS.
	Key *string `locationName:"key" min:"1" type:"string"`

	// The throughput value of the Elastic Inference Accelerator type.
	Value *int64 `locationName:"value" type:"integer"`
	// contains filtered or unexported fields
}

A throughput entry for an Elastic Inference Accelerator type.

func (KeyValuePair) GoString

func (s KeyValuePair) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeyValuePair) SetKey

func (s *KeyValuePair) SetKey(v string) *KeyValuePair

SetKey sets the Key field's value.

func (*KeyValuePair) SetValue

func (s *KeyValuePair) SetValue(v int64) *KeyValuePair

SetValue sets the Value field's value.

func (KeyValuePair) String

func (s KeyValuePair) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

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

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

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

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MemoryInfo

type MemoryInfo struct {

	// The size in mebibytes of the Elastic Inference Accelerator type.
	SizeInMiB *int64 `locationName:"sizeInMiB" type:"integer"`
	// contains filtered or unexported fields
}

The memory information of an Elastic Inference Accelerator type.

func (MemoryInfo) GoString

func (s MemoryInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MemoryInfo) SetSizeInMiB

func (s *MemoryInfo) SetSizeInMiB(v int64) *MemoryInfo

SetSizeInMiB sets the SizeInMiB field's value.

func (MemoryInfo) String

func (s MemoryInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

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

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

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

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

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

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

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

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package elasticinferenceiface provides an interface to enable mocking the Amazon Elastic Inference service client for testing your code.
Package elasticinferenceiface provides an interface to enable mocking the Amazon Elastic Inference service client for testing your code.

Jump to

Keyboard shortcuts

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