AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GlobalAccelerator

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

type GlobalAccelerator struct { *client.Client }

GlobalAccelerator provides the API operation methods for making requests to AWS Global Accelerator. See this package's package overview docs for details on the service.

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

Client

Type: *client.Client

Method

CreateAccelerator

func (c *GlobalAccelerator) CreateAccelerator(input *CreateAcceleratorInput) (*CreateAcceleratorOutput, error)

CreateAccelerator API operation for AWS Global Accelerator.

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation CreateAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateAccelerator

CreateAcceleratorRequest

func (c *GlobalAccelerator) CreateAcceleratorRequest(input *CreateAcceleratorInput) (req *request.Request, output *CreateAcceleratorOutput)

CreateAcceleratorRequest generates a "aws/request.Request" representing the client's request for the CreateAccelerator 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 CreateAccelerator for more information on using the CreateAccelerator 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 CreateAcceleratorRequest method. req, resp := client.CreateAcceleratorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateAccelerator

CreateAcceleratorWithContext

func (c *GlobalAccelerator) CreateAcceleratorWithContext(ctx aws.Context, input *CreateAcceleratorInput, opts ...request.Option) (*CreateAcceleratorOutput, error)

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

See CreateAccelerator 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.

See Also

For more information about using this API, see AWS API Documentation.

CreateEndpointGroup

func (c *GlobalAccelerator) CreateEndpointGroup(input *CreateEndpointGroupInput) (*CreateEndpointGroupOutput, error)

CreateEndpointGroup API operation for AWS Global Accelerator.

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation CreateEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeEndpointGroupAlreadyExistsException "EndpointGroupAlreadyExistsException" The endpoint group that you specified already exists.

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateEndpointGroup

CreateEndpointGroupRequest

func (c *GlobalAccelerator) CreateEndpointGroupRequest(input *CreateEndpointGroupInput) (req *request.Request, output *CreateEndpointGroupOutput)

CreateEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the CreateEndpointGroup 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 CreateEndpointGroup for more information on using the CreateEndpointGroup 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 CreateEndpointGroupRequest method. req, resp := client.CreateEndpointGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateEndpointGroup

CreateEndpointGroupWithContext

func (c *GlobalAccelerator) CreateEndpointGroupWithContext(ctx aws.Context, input *CreateEndpointGroupInput, opts ...request.Option) (*CreateEndpointGroupOutput, error)

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

See CreateEndpointGroup 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.

See Also

For more information about using this API, see AWS API Documentation.

CreateListener

func (c *GlobalAccelerator) CreateListener(input *CreateListenerInput) (*CreateListenerOutput, error)

CreateListener API operation for AWS Global Accelerator.

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation CreateListener for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInvalidPortRangeException "InvalidPortRangeException" The port numbers that you specified are not valid numbers or are not unique for this accelerator.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateListener

CreateListenerRequest

func (c *GlobalAccelerator) CreateListenerRequest(input *CreateListenerInput) (req *request.Request, output *CreateListenerOutput)

CreateListenerRequest generates a "aws/request.Request" representing the client's request for the CreateListener 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 CreateListener for more information on using the CreateListener 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 CreateListenerRequest method. req, resp := client.CreateListenerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateListener

CreateListenerWithContext

func (c *GlobalAccelerator) CreateListenerWithContext(ctx aws.Context, input *CreateListenerInput, opts ...request.Option) (*CreateListenerOutput, error)

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

See CreateListener 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteAccelerator

func (c *GlobalAccelerator) DeleteAccelerator(input *DeleteAcceleratorInput) (*DeleteAcceleratorOutput, error)

DeleteAccelerator API operation for AWS Global Accelerator.

Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DeleteAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeAcceleratorNotDisabledException "AcceleratorNotDisabledException" The accelerator that you specified could not be disabled.

  • ErrCodeAssociatedListenerFoundException "AssociatedListenerFoundException" The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteAccelerator

DeleteAcceleratorRequest

func (c *GlobalAccelerator) DeleteAcceleratorRequest(input *DeleteAcceleratorInput) (req *request.Request, output *DeleteAcceleratorOutput)

DeleteAcceleratorRequest generates a "aws/request.Request" representing the client's request for the DeleteAccelerator 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 DeleteAccelerator for more information on using the DeleteAccelerator 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 DeleteAcceleratorRequest method. req, resp := client.DeleteAcceleratorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteAccelerator

DeleteAcceleratorWithContext

func (c *GlobalAccelerator) DeleteAcceleratorWithContext(ctx aws.Context, input *DeleteAcceleratorInput, opts ...request.Option) (*DeleteAcceleratorOutput, error)

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

See DeleteAccelerator 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteEndpointGroup

func (c *GlobalAccelerator) DeleteEndpointGroup(input *DeleteEndpointGroupInput) (*DeleteEndpointGroupOutput, error)

DeleteEndpointGroup API operation for AWS Global Accelerator.

Delete an endpoint group from a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DeleteEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeEndpointGroupNotFoundException "EndpointGroupNotFoundException" The endpoint group that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteEndpointGroup

DeleteEndpointGroupRequest

func (c *GlobalAccelerator) DeleteEndpointGroupRequest(input *DeleteEndpointGroupInput) (req *request.Request, output *DeleteEndpointGroupOutput)

DeleteEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpointGroup 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 DeleteEndpointGroup for more information on using the DeleteEndpointGroup 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 DeleteEndpointGroupRequest method. req, resp := client.DeleteEndpointGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteEndpointGroup

DeleteEndpointGroupWithContext

func (c *GlobalAccelerator) DeleteEndpointGroupWithContext(ctx aws.Context, input *DeleteEndpointGroupInput, opts ...request.Option) (*DeleteEndpointGroupOutput, error)

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

See DeleteEndpointGroup 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.

See Also

For more information about using this API, see AWS API Documentation.

DeleteListener

func (c *GlobalAccelerator) DeleteListener(input *DeleteListenerInput) (*DeleteListenerOutput, error)

DeleteListener API operation for AWS Global Accelerator.

Delete a listener from an 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 AWS Global Accelerator's API operation DeleteListener for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeAssociatedEndpointGroupFoundException "AssociatedEndpointGroupFoundException" The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteListener

DeleteListenerRequest

func (c *GlobalAccelerator) DeleteListenerRequest(input *DeleteListenerInput) (req *request.Request, output *DeleteListenerOutput)

DeleteListenerRequest generates a "aws/request.Request" representing the client's request for the DeleteListener 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 DeleteListener for more information on using the DeleteListener 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 DeleteListenerRequest method. req, resp := client.DeleteListenerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteListener

DeleteListenerWithContext

func (c *GlobalAccelerator) DeleteListenerWithContext(ctx aws.Context, input *DeleteListenerInput, opts ...request.Option) (*DeleteListenerOutput, error)

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

See DeleteListener 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeAccelerator

func (c *GlobalAccelerator) DescribeAccelerator(input *DescribeAcceleratorInput) (*DescribeAcceleratorOutput, error)

DescribeAccelerator API operation for AWS Global Accelerator.

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAccelerator

DescribeAcceleratorAttributes

func (c *GlobalAccelerator) DescribeAcceleratorAttributes(input *DescribeAcceleratorAttributesInput) (*DescribeAcceleratorAttributesOutput, error)

DescribeAcceleratorAttributes API operation for AWS Global Accelerator.

Describe the attributes of an 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 AWS Global Accelerator's API operation DescribeAcceleratorAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAcceleratorAttributes

DescribeAcceleratorAttributesRequest

func (c *GlobalAccelerator) DescribeAcceleratorAttributesRequest(input *DescribeAcceleratorAttributesInput) (req *request.Request, output *DescribeAcceleratorAttributesOutput)

DescribeAcceleratorAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeAcceleratorAttributes 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 DescribeAcceleratorAttributes for more information on using the DescribeAcceleratorAttributes 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 DescribeAcceleratorAttributesRequest method. req, resp := client.DescribeAcceleratorAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAcceleratorAttributes

DescribeAcceleratorAttributesWithContext

func (c *GlobalAccelerator) DescribeAcceleratorAttributesWithContext(ctx aws.Context, input *DescribeAcceleratorAttributesInput, opts ...request.Option) (*DescribeAcceleratorAttributesOutput, error)

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

See DescribeAcceleratorAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeAcceleratorRequest

func (c *GlobalAccelerator) DescribeAcceleratorRequest(input *DescribeAcceleratorInput) (req *request.Request, output *DescribeAcceleratorOutput)

DescribeAcceleratorRequest generates a "aws/request.Request" representing the client's request for the DescribeAccelerator 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 DescribeAccelerator for more information on using the DescribeAccelerator 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 DescribeAcceleratorRequest method. req, resp := client.DescribeAcceleratorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAccelerator

DescribeAcceleratorWithContext

func (c *GlobalAccelerator) DescribeAcceleratorWithContext(ctx aws.Context, input *DescribeAcceleratorInput, opts ...request.Option) (*DescribeAcceleratorOutput, error)

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

See DescribeAccelerator 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeEndpointGroup

func (c *GlobalAccelerator) DescribeEndpointGroup(input *DescribeEndpointGroupInput) (*DescribeEndpointGroupOutput, error)

DescribeEndpointGroup API operation for AWS Global Accelerator.

Describe an endpoint group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeEndpointGroupNotFoundException "EndpointGroupNotFoundException" The endpoint group that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeEndpointGroup

DescribeEndpointGroupRequest

func (c *GlobalAccelerator) DescribeEndpointGroupRequest(input *DescribeEndpointGroupInput) (req *request.Request, output *DescribeEndpointGroupOutput)

DescribeEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpointGroup 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 DescribeEndpointGroup for more information on using the DescribeEndpointGroup 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 DescribeEndpointGroupRequest method. req, resp := client.DescribeEndpointGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeEndpointGroup

DescribeEndpointGroupWithContext

func (c *GlobalAccelerator) DescribeEndpointGroupWithContext(ctx aws.Context, input *DescribeEndpointGroupInput, opts ...request.Option) (*DescribeEndpointGroupOutput, error)

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

See DescribeEndpointGroup 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.

See Also

For more information about using this API, see AWS API Documentation.

DescribeListener

func (c *GlobalAccelerator) DescribeListener(input *DescribeListenerInput) (*DescribeListenerOutput, error)

DescribeListener API operation for AWS Global Accelerator.

Describe a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeListener for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeListener

DescribeListenerRequest

func (c *GlobalAccelerator) DescribeListenerRequest(input *DescribeListenerInput) (req *request.Request, output *DescribeListenerOutput)

DescribeListenerRequest generates a "aws/request.Request" representing the client's request for the DescribeListener 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 DescribeListener for more information on using the DescribeListener 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 DescribeListenerRequest method. req, resp := client.DescribeListenerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeListener

DescribeListenerWithContext

func (c *GlobalAccelerator) DescribeListenerWithContext(ctx aws.Context, input *DescribeListenerInput, opts ...request.Option) (*DescribeListenerOutput, error)

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

See DescribeListener 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.

See Also

For more information about using this API, see AWS API Documentation.

ListAccelerators

func (c *GlobalAccelerator) ListAccelerators(input *ListAcceleratorsInput) (*ListAcceleratorsOutput, error)

ListAccelerators API operation for AWS Global Accelerator.

List the accelerators for an AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation ListAccelerators for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" There isn't another item to return.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListAccelerators

ListAcceleratorsRequest

func (c *GlobalAccelerator) ListAcceleratorsRequest(input *ListAcceleratorsInput) (req *request.Request, output *ListAcceleratorsOutput)

ListAcceleratorsRequest generates a "aws/request.Request" representing the client's request for the ListAccelerators 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 ListAccelerators for more information on using the ListAccelerators 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 ListAcceleratorsRequest method. req, resp := client.ListAcceleratorsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListAccelerators

ListAcceleratorsWithContext

func (c *GlobalAccelerator) ListAcceleratorsWithContext(ctx aws.Context, input *ListAcceleratorsInput, opts ...request.Option) (*ListAcceleratorsOutput, error)

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

See ListAccelerators 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.

See Also

For more information about using this API, see AWS API Documentation.

ListEndpointGroups

func (c *GlobalAccelerator) ListEndpointGroups(input *ListEndpointGroupsInput) (*ListEndpointGroupsOutput, error)

ListEndpointGroups API operation for AWS Global Accelerator.

List the endpoint groups that are associated with a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation ListEndpointGroups for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" There isn't another item to return.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListEndpointGroups

ListEndpointGroupsRequest

func (c *GlobalAccelerator) ListEndpointGroupsRequest(input *ListEndpointGroupsInput) (req *request.Request, output *ListEndpointGroupsOutput)

ListEndpointGroupsRequest generates a "aws/request.Request" representing the client's request for the ListEndpointGroups 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 ListEndpointGroups for more information on using the ListEndpointGroups 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 ListEndpointGroupsRequest method. req, resp := client.ListEndpointGroupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListEndpointGroups

ListEndpointGroupsWithContext

func (c *GlobalAccelerator) ListEndpointGroupsWithContext(ctx aws.Context, input *ListEndpointGroupsInput, opts ...request.Option) (*ListEndpointGroupsOutput, error)

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

See ListEndpointGroups 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.

See Also

For more information about using this API, see AWS API Documentation.

ListListeners

func (c *GlobalAccelerator) ListListeners(input *ListListenersInput) (*ListListenersOutput, error)

ListListeners API operation for AWS Global Accelerator.

List the listeners for an 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 AWS Global Accelerator's API operation ListListeners for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" There isn't another item to return.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListListeners

ListListenersRequest

func (c *GlobalAccelerator) ListListenersRequest(input *ListListenersInput) (req *request.Request, output *ListListenersOutput)

ListListenersRequest generates a "aws/request.Request" representing the client's request for the ListListeners 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 ListListeners for more information on using the ListListeners 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 ListListenersRequest method. req, resp := client.ListListenersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListListeners

ListListenersWithContext

func (c *GlobalAccelerator) ListListenersWithContext(ctx aws.Context, input *ListListenersInput, opts ...request.Option) (*ListListenersOutput, error)

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

See ListListeners 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateAccelerator

func (c *GlobalAccelerator) UpdateAccelerator(input *UpdateAcceleratorInput) (*UpdateAcceleratorOutput, error)

UpdateAccelerator API operation for AWS Global Accelerator.

Update an 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 AWS Global Accelerator's API operation UpdateAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAccelerator

UpdateAcceleratorAttributes

func (c *GlobalAccelerator) UpdateAcceleratorAttributes(input *UpdateAcceleratorAttributesInput) (*UpdateAcceleratorAttributesOutput, error)

UpdateAcceleratorAttributes API operation for AWS Global Accelerator.

Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateAcceleratorAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAcceleratorAttributes

UpdateAcceleratorAttributesRequest

func (c *GlobalAccelerator) UpdateAcceleratorAttributesRequest(input *UpdateAcceleratorAttributesInput) (req *request.Request, output *UpdateAcceleratorAttributesOutput)

UpdateAcceleratorAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateAcceleratorAttributes 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 UpdateAcceleratorAttributes for more information on using the UpdateAcceleratorAttributes 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 UpdateAcceleratorAttributesRequest method. req, resp := client.UpdateAcceleratorAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAcceleratorAttributes

UpdateAcceleratorAttributesWithContext

func (c *GlobalAccelerator) UpdateAcceleratorAttributesWithContext(ctx aws.Context, input *UpdateAcceleratorAttributesInput, opts ...request.Option) (*UpdateAcceleratorAttributesOutput, error)

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

See UpdateAcceleratorAttributes 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateAcceleratorRequest

func (c *GlobalAccelerator) UpdateAcceleratorRequest(input *UpdateAcceleratorInput) (req *request.Request, output *UpdateAcceleratorOutput)

UpdateAcceleratorRequest generates a "aws/request.Request" representing the client's request for the UpdateAccelerator 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 UpdateAccelerator for more information on using the UpdateAccelerator 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 UpdateAcceleratorRequest method. req, resp := client.UpdateAcceleratorRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAccelerator

UpdateAcceleratorWithContext

func (c *GlobalAccelerator) UpdateAcceleratorWithContext(ctx aws.Context, input *UpdateAcceleratorInput, opts ...request.Option) (*UpdateAcceleratorOutput, error)

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

See UpdateAccelerator 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateEndpointGroup

func (c *GlobalAccelerator) UpdateEndpointGroup(input *UpdateEndpointGroupInput) (*UpdateEndpointGroupOutput, error)

UpdateEndpointGroup API operation for AWS Global Accelerator.

Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeEndpointGroupNotFoundException "EndpointGroupNotFoundException" The endpoint group that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateEndpointGroup

UpdateEndpointGroupRequest

func (c *GlobalAccelerator) UpdateEndpointGroupRequest(input *UpdateEndpointGroupInput) (req *request.Request, output *UpdateEndpointGroupOutput)

UpdateEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateEndpointGroup 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 UpdateEndpointGroup for more information on using the UpdateEndpointGroup 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 UpdateEndpointGroupRequest method. req, resp := client.UpdateEndpointGroupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateEndpointGroup

UpdateEndpointGroupWithContext

func (c *GlobalAccelerator) UpdateEndpointGroupWithContext(ctx aws.Context, input *UpdateEndpointGroupInput, opts ...request.Option) (*UpdateEndpointGroupOutput, error)

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

See UpdateEndpointGroup 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.

See Also

For more information about using this API, see AWS API Documentation.

UpdateListener

func (c *GlobalAccelerator) UpdateListener(input *UpdateListenerInput) (*UpdateListenerOutput, error)

UpdateListener API operation for AWS Global Accelerator.

Update a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateListener for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeInvalidPortRangeException "InvalidPortRangeException" The port numbers that you specified are not valid numbers or are not unique for this accelerator.

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateListener

UpdateListenerRequest

func (c *GlobalAccelerator) UpdateListenerRequest(input *UpdateListenerInput) (req *request.Request, output *UpdateListenerOutput)

UpdateListenerRequest generates a "aws/request.Request" representing the client's request for the UpdateListener 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 UpdateListener for more information on using the UpdateListener 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 UpdateListenerRequest method. req, resp := client.UpdateListenerRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateListener

UpdateListenerWithContext

func (c *GlobalAccelerator) UpdateListenerWithContext(ctx aws.Context, input *UpdateListenerInput, opts ...request.Option) (*UpdateListenerOutput, error)

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

See UpdateListener 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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: