package elasticinference
import "github.com/aws/aws-sdk-go-v2/service/elasticinference"
Package elasticinference provides the API client, operations, and parameter types for Amazon Elastic Inference.
Elastic Inference public APIs.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) DescribeAcceleratorOfferings(ctx context.Context, params *DescribeAcceleratorOfferingsInput, optFns ...func(*Options)) (*DescribeAcceleratorOfferingsOutput, error)
- func (c *Client) DescribeAcceleratorTypes(ctx context.Context, params *DescribeAcceleratorTypesInput, optFns ...func(*Options)) (*DescribeAcceleratorTypesOutput, error)
- func (c *Client) DescribeAccelerators(ctx context.Context, params *DescribeAcceleratorsInput, optFns ...func(*Options)) (*DescribeAcceleratorsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- type DescribeAcceleratorOfferingsInput
- type DescribeAcceleratorOfferingsOutput
- type DescribeAcceleratorTypesInput
- type DescribeAcceleratorTypesOutput
- type DescribeAcceleratorsAPIClient
- type DescribeAcceleratorsInput
- type DescribeAcceleratorsOutput
- type DescribeAcceleratorsPaginator
- func NewDescribeAcceleratorsPaginator(client DescribeAcceleratorsAPIClient, params *DescribeAcceleratorsInput, optFns ...func(*DescribeAcceleratorsPaginatorOptions)) *DescribeAcceleratorsPaginator
- func (p *DescribeAcceleratorsPaginator) HasMorePages() bool
- func (p *DescribeAcceleratorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAcceleratorsOutput, error)
- type DescribeAcceleratorsPaginatorOptions
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type HTTPClient
- type HTTPSignerV4
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
Constants ¶
const ServiceAPIVersion = "2017-07-25"
const ServiceID = "Elastic Inference"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Elastic Inference.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) DescribeAcceleratorOfferings ¶
func (c *Client) DescribeAcceleratorOfferings(ctx context.Context, params *DescribeAcceleratorOfferingsInput, optFns ...func(*Options)) (*DescribeAcceleratorOfferingsOutput, error)
Describes the locations in which a given accelerator type or set of types is present in a given region.
func (*Client) DescribeAcceleratorTypes ¶
func (c *Client) DescribeAcceleratorTypes(ctx context.Context, params *DescribeAcceleratorTypesInput, optFns ...func(*Options)) (*DescribeAcceleratorTypesOutput, error)
Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.
func (*Client) DescribeAccelerators ¶
func (c *Client) DescribeAccelerators(ctx context.Context, params *DescribeAcceleratorsInput, optFns ...func(*Options)) (*DescribeAcceleratorsOutput, error)
Describes information over a provided set of accelerators belonging to an account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns all tags of an Elastic Inference Accelerator.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds the specified tags to an Elastic Inference Accelerator.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes the specified tags from an Elastic Inference Accelerator.
type DescribeAcceleratorOfferingsInput ¶
type DescribeAcceleratorOfferingsInput struct { // 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. // // This member is required. LocationType types.LocationType // The list of accelerator types to describe. AcceleratorTypes []string }
type DescribeAcceleratorOfferingsOutput ¶
type DescribeAcceleratorOfferingsOutput struct { // The list of accelerator type offerings for a specific location. AcceleratorTypeOfferings []types.AcceleratorTypeOffering // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAcceleratorTypesInput ¶
type DescribeAcceleratorTypesInput struct { }
type DescribeAcceleratorTypesOutput ¶
type DescribeAcceleratorTypesOutput struct { // The available accelerator types. AcceleratorTypes []types.AcceleratorType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAcceleratorsAPIClient ¶
type DescribeAcceleratorsAPIClient interface { DescribeAccelerators(context.Context, *DescribeAcceleratorsInput, ...func(*Options)) (*DescribeAcceleratorsOutput, error) }
DescribeAcceleratorsAPIClient is a client that implements the DescribeAccelerators operation.
type DescribeAcceleratorsInput ¶
type DescribeAcceleratorsInput struct { // The IDs of the accelerators to describe. AcceleratorIds []string // 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 []types.Filter // 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 int32 // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string }
type DescribeAcceleratorsOutput ¶
type DescribeAcceleratorsOutput struct { // The details of the Elastic Inference Accelerators. AcceleratorSet []types.ElasticInferenceAccelerator // A token to specify where to start paginating. This is the NextToken from a // previously truncated response. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAcceleratorsPaginator ¶
type DescribeAcceleratorsPaginator struct {
// contains filtered or unexported fields
}
DescribeAcceleratorsPaginator is a paginator for DescribeAccelerators
func NewDescribeAcceleratorsPaginator ¶
func NewDescribeAcceleratorsPaginator(client DescribeAcceleratorsAPIClient, params *DescribeAcceleratorsInput, optFns ...func(*DescribeAcceleratorsPaginatorOptions)) *DescribeAcceleratorsPaginator
NewDescribeAcceleratorsPaginator returns a new DescribeAcceleratorsPaginator
func (*DescribeAcceleratorsPaginator) HasMorePages ¶
func (p *DescribeAcceleratorsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeAcceleratorsPaginator) NextPage ¶
func (p *DescribeAcceleratorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAcceleratorsOutput, error)
NextPage retrieves the next DescribeAccelerators page.
type DescribeAcceleratorsPaginatorOptions ¶
type DescribeAcceleratorsPaginatorOptions struct { // 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. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeAcceleratorsPaginatorOptions is the paginator options for DescribeAccelerators
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The ARN of the Elastic Inference Accelerator to list the tags for. // // This member is required. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags of the Elastic Inference Accelerator. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer aws.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The ARN of the Elastic Inference Accelerator to tag. // // This member is required. ResourceArn *string // The tags to add to the Elastic Inference Accelerator. // // This member is required. Tags map[string]string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The ARN of the Elastic Inference Accelerator to untag. // // This member is required. ResourceArn *string // The list of tags to remove from the Elastic Inference Accelerator. // // This member is required. TagKeys []string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_DescribeAcceleratorOfferings.go api_op_DescribeAcceleratorTypes.go api_op_DescribeAccelerators.go api_op_ListTagsForResource.go api_op_TagResource.go api_op_UntagResource.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.1.4
- Published
- Apr 2, 2021
- Platform
- windows/amd64
- Imports
- 26 packages
- Last checked
- now –
Tools for package owners.