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.

MQ

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

type MQ struct { *client.Client }

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

MQ 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

CreateBroker

func (c *MQ) CreateBroker(input *CreateBrokerRequest) (*CreateBrokerResponse, error)

CreateBroker API operation for AmazonMQ.

Creates a broker. Note: This API is asynchronous.

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 AmazonMQ's API operation CreateBroker for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeUnauthorizedException "UnauthorizedException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeConflictException "ConflictException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBroker

CreateBrokerRequest

func (c *MQ) CreateBrokerRequest(input *CreateBrokerRequest) (req *request.Request, output *CreateBrokerResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBroker

CreateBrokerWithContext

func (c *MQ) CreateBrokerWithContext(ctx aws.Context, input *CreateBrokerRequest, opts ...request.Option) (*CreateBrokerResponse, error)

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

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

CreateConfiguration

func (c *MQ) CreateConfiguration(input *CreateConfigurationRequest) (*CreateConfigurationResponse, error)

CreateConfiguration API operation for AmazonMQ.

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

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 AmazonMQ's API operation CreateConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeConflictException "ConflictException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfiguration

CreateConfigurationRequest

func (c *MQ) CreateConfigurationRequest(input *CreateConfigurationRequest) (req *request.Request, output *CreateConfigurationResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfiguration

CreateConfigurationWithContext

func (c *MQ) CreateConfigurationWithContext(ctx aws.Context, input *CreateConfigurationRequest, opts ...request.Option) (*CreateConfigurationResponse, error)

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

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

CreateTags

func (c *MQ) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)

CreateTags API operation for AmazonMQ.

Add a tag to a resource.

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 AmazonMQ's API operation CreateTags for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateTags

CreateTagsRequest

func (c *MQ) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateTags

CreateTagsWithContext

func (c *MQ) CreateTagsWithContext(ctx aws.Context, input *CreateTagsInput, opts ...request.Option) (*CreateTagsOutput, error)

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

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

CreateUser

func (c *MQ) CreateUser(input *CreateUserRequest) (*CreateUserOutput, error)

CreateUser API operation for AmazonMQ.

Creates an ActiveMQ user.

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 AmazonMQ's API operation CreateUser for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeConflictException "ConflictException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUser

CreateUserRequest

func (c *MQ) CreateUserRequest(input *CreateUserRequest) (req *request.Request, output *CreateUserOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUser

CreateUserWithContext

func (c *MQ) CreateUserWithContext(ctx aws.Context, input *CreateUserRequest, opts ...request.Option) (*CreateUserOutput, error)

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

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

DeleteBroker

func (c *MQ) DeleteBroker(input *DeleteBrokerInput) (*DeleteBrokerResponse, error)

DeleteBroker API operation for AmazonMQ.

Deletes a broker. Note: This API is asynchronous.

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 AmazonMQ's API operation DeleteBroker for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBroker

DeleteBrokerRequest

func (c *MQ) DeleteBrokerRequest(input *DeleteBrokerInput) (req *request.Request, output *DeleteBrokerResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBroker

DeleteBrokerWithContext

func (c *MQ) DeleteBrokerWithContext(ctx aws.Context, input *DeleteBrokerInput, opts ...request.Option) (*DeleteBrokerResponse, error)

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

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

DeleteTags

func (c *MQ) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)

DeleteTags API operation for AmazonMQ.

Remove a tag from a resource.

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 AmazonMQ's API operation DeleteTags for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteTags

DeleteTagsRequest

func (c *MQ) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteTags

DeleteTagsWithContext

func (c *MQ) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error)

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

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

DeleteUser

func (c *MQ) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for AmazonMQ.

Deletes an ActiveMQ user.

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 AmazonMQ's API operation DeleteUser for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUser

DeleteUserRequest

func (c *MQ) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUser

DeleteUserWithContext

func (c *MQ) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

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

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

DescribeBroker

func (c *MQ) DescribeBroker(input *DescribeBrokerInput) (*DescribeBrokerResponse, error)

DescribeBroker API operation for AmazonMQ.

Returns information about the specified broker.

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 AmazonMQ's API operation DescribeBroker for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBroker

DescribeBrokerRequest

func (c *MQ) DescribeBrokerRequest(input *DescribeBrokerInput) (req *request.Request, output *DescribeBrokerResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBroker

DescribeBrokerWithContext

func (c *MQ) DescribeBrokerWithContext(ctx aws.Context, input *DescribeBrokerInput, opts ...request.Option) (*DescribeBrokerResponse, error)

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

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

DescribeConfiguration

func (c *MQ) DescribeConfiguration(input *DescribeConfigurationInput) (*DescribeConfigurationOutput, error)

DescribeConfiguration API operation for AmazonMQ.

Returns information about the specified configuration.

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 AmazonMQ's API operation DescribeConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfiguration

DescribeConfigurationRequest

func (c *MQ) DescribeConfigurationRequest(input *DescribeConfigurationInput) (req *request.Request, output *DescribeConfigurationOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfiguration

DescribeConfigurationRevision

func (c *MQ) DescribeConfigurationRevision(input *DescribeConfigurationRevisionInput) (*DescribeConfigurationRevisionResponse, error)

DescribeConfigurationRevision API operation for AmazonMQ.

Returns the specified configuration revision for the specified configuration.

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 AmazonMQ's API operation DescribeConfigurationRevision for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevision

DescribeConfigurationRevisionRequest

func (c *MQ) DescribeConfigurationRevisionRequest(input *DescribeConfigurationRevisionInput) (req *request.Request, output *DescribeConfigurationRevisionResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevision

DescribeConfigurationRevisionWithContext

func (c *MQ) DescribeConfigurationRevisionWithContext(ctx aws.Context, input *DescribeConfigurationRevisionInput, opts ...request.Option) (*DescribeConfigurationRevisionResponse, error)

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

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

DescribeConfigurationWithContext

func (c *MQ) DescribeConfigurationWithContext(ctx aws.Context, input *DescribeConfigurationInput, opts ...request.Option) (*DescribeConfigurationOutput, error)

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

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

DescribeUser

func (c *MQ) DescribeUser(input *DescribeUserInput) (*DescribeUserResponse, error)

DescribeUser API operation for AmazonMQ.

Returns information about an ActiveMQ user.

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 AmazonMQ's API operation DescribeUser for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUser

DescribeUserRequest

func (c *MQ) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUser

DescribeUserWithContext

func (c *MQ) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserResponse, error)

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

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

ListBrokers

func (c *MQ) ListBrokers(input *ListBrokersInput) (*ListBrokersResponse, error)

ListBrokers API operation for AmazonMQ.

Returns a list of all brokers.

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 AmazonMQ's API operation ListBrokers for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokers

ListBrokersRequest

func (c *MQ) ListBrokersRequest(input *ListBrokersInput) (req *request.Request, output *ListBrokersResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokers

ListBrokersWithContext

func (c *MQ) ListBrokersWithContext(ctx aws.Context, input *ListBrokersInput, opts ...request.Option) (*ListBrokersResponse, error)

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

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

ListConfigurationRevisions

func (c *MQ) ListConfigurationRevisions(input *ListConfigurationRevisionsInput) (*ListConfigurationRevisionsResponse, error)

ListConfigurationRevisions API operation for AmazonMQ.

Returns a list of all revisions for the specified configuration.

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 AmazonMQ's API operation ListConfigurationRevisions for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisions

ListConfigurationRevisionsRequest

func (c *MQ) ListConfigurationRevisionsRequest(input *ListConfigurationRevisionsInput) (req *request.Request, output *ListConfigurationRevisionsResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisions

ListConfigurationRevisionsWithContext

func (c *MQ) ListConfigurationRevisionsWithContext(ctx aws.Context, input *ListConfigurationRevisionsInput, opts ...request.Option) (*ListConfigurationRevisionsResponse, error)

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

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

ListConfigurations

func (c *MQ) ListConfigurations(input *ListConfigurationsInput) (*ListConfigurationsResponse, error)

ListConfigurations API operation for AmazonMQ.

Returns a list of all configurations.

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 AmazonMQ's API operation ListConfigurations for usage and error information.

Returned Error Codes:

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurations

ListConfigurationsRequest

func (c *MQ) ListConfigurationsRequest(input *ListConfigurationsInput) (req *request.Request, output *ListConfigurationsResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurations

ListConfigurationsWithContext

func (c *MQ) ListConfigurationsWithContext(ctx aws.Context, input *ListConfigurationsInput, opts ...request.Option) (*ListConfigurationsResponse, error)

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

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

ListTags

func (c *MQ) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

ListTags API operation for AmazonMQ.

Lists tags for a resource.

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 AmazonMQ's API operation ListTags for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListTags

ListTagsRequest

func (c *MQ) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListTags

ListTagsWithContext

func (c *MQ) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

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

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

ListUsers

func (c *MQ) ListUsers(input *ListUsersInput) (*ListUsersResponse, error)

ListUsers API operation for AmazonMQ.

Returns a list of all ActiveMQ users.

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 AmazonMQ's API operation ListUsers for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsers

ListUsersRequest

func (c *MQ) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsers

ListUsersWithContext

func (c *MQ) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersResponse, error)

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

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

RebootBroker

func (c *MQ) RebootBroker(input *RebootBrokerInput) (*RebootBrokerOutput, error)

RebootBroker API operation for AmazonMQ.

Reboots a broker. Note: This API is asynchronous.

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 AmazonMQ's API operation RebootBroker for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBroker

RebootBrokerRequest

func (c *MQ) RebootBrokerRequest(input *RebootBrokerInput) (req *request.Request, output *RebootBrokerOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBroker

RebootBrokerWithContext

func (c *MQ) RebootBrokerWithContext(ctx aws.Context, input *RebootBrokerInput, opts ...request.Option) (*RebootBrokerOutput, error)

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

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

UpdateBroker

func (c *MQ) UpdateBroker(input *UpdateBrokerRequest) (*UpdateBrokerResponse, error)

UpdateBroker API operation for AmazonMQ.

Adds a pending configuration change to a broker.

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 AmazonMQ's API operation UpdateBroker for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeConflictException "ConflictException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBroker

UpdateBrokerRequest

func (c *MQ) UpdateBrokerRequest(input *UpdateBrokerRequest) (req *request.Request, output *UpdateBrokerResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBroker

UpdateBrokerWithContext

func (c *MQ) UpdateBrokerWithContext(ctx aws.Context, input *UpdateBrokerRequest, opts ...request.Option) (*UpdateBrokerResponse, error)

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

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

UpdateConfiguration

func (c *MQ) UpdateConfiguration(input *UpdateConfigurationRequest) (*UpdateConfigurationResponse, error)

UpdateConfiguration API operation for AmazonMQ.

Updates the specified configuration.

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 AmazonMQ's API operation UpdateConfiguration for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeConflictException "ConflictException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfiguration

UpdateConfigurationRequest

func (c *MQ) UpdateConfigurationRequest(input *UpdateConfigurationRequest) (req *request.Request, output *UpdateConfigurationResponse)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfiguration

UpdateConfigurationWithContext

func (c *MQ) UpdateConfigurationWithContext(ctx aws.Context, input *UpdateConfigurationRequest, opts ...request.Option) (*UpdateConfigurationResponse, error)

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

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

UpdateUser

func (c *MQ) UpdateUser(input *UpdateUserRequest) (*UpdateUserOutput, error)

UpdateUser API operation for AmazonMQ.

Updates the information for an ActiveMQ user.

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 AmazonMQ's API operation UpdateUser for usage and error information.

Returned Error Codes:

  • ErrCodeNotFoundException "NotFoundException" Returns information about an error.

  • ErrCodeBadRequestException "BadRequestException" Returns information about an error.

  • ErrCodeInternalServerErrorException "InternalServerErrorException" Returns information about an error.

  • ErrCodeConflictException "ConflictException" Returns information about an error.

  • ErrCodeForbiddenException "ForbiddenException" Returns information about an error.

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUser

UpdateUserRequest

func (c *MQ) UpdateUserRequest(input *UpdateUserRequest) (req *request.Request, output *UpdateUserOutput)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUser

UpdateUserWithContext

func (c *MQ) UpdateUserWithContext(ctx aws.Context, input *UpdateUserRequest, opts ...request.Option) (*UpdateUserOutput, error)

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

See UpdateUser 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: