mq

package
v2.0.0-preview.4+incom... Latest Latest
Warning

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

Go to latest
Published: May 26, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package mq provides the client and types for making API requests to AmazonMQ.

Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

See https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27 for more information on this service.

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

Using the Client

To AmazonMQ with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AmazonMQ client MQ for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mq/#New

Index

Constants

View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Returns information about an error.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Returns information about an error.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// Returns information about an error.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// Returns information about an error.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// Returns information about an error.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// Returns information about an error.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source
const (
	ServiceName = "mq"        // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type BrokerInstance

type BrokerInstance struct {

	// The URL of the broker's ActiveMQ Web Console.
	ConsoleURL *string `locationName:"consoleURL" type:"string"`

	// The broker's wire-level protocol endpoints.
	Endpoints []string `locationName:"endpoints" type:"list"`
	// contains filtered or unexported fields
}

Returns information about all brokers. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/BrokerInstance

func (BrokerInstance) GoString

func (s BrokerInstance) GoString() string

GoString returns the string representation

func (BrokerInstance) MarshalFields

func (s BrokerInstance) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerInstance) String

func (s BrokerInstance) String() string

String returns the string representation

type BrokerState

type BrokerState string

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

const (
	BrokerStateCreationInProgress BrokerState = "CREATION_IN_PROGRESS"
	BrokerStateCreationFailed     BrokerState = "CREATION_FAILED"
	BrokerStateDeletionInProgress BrokerState = "DELETION_IN_PROGRESS"
	BrokerStateRunning            BrokerState = "RUNNING"
	BrokerStateRebootInProgress   BrokerState = "REBOOT_IN_PROGRESS"
)

Enum values for BrokerState

func (BrokerState) MarshalValue

func (enum BrokerState) MarshalValue() (string, error)

func (BrokerState) MarshalValueBuf

func (enum BrokerState) MarshalValueBuf(b []byte) ([]byte, error)

type BrokerSummary

type BrokerSummary struct {

	// The Amazon Resource Name (ARN) of the broker.
	BrokerArn *string `locationName:"brokerArn" type:"string"`

	// The unique ID that Amazon MQ generates for the broker.
	BrokerId *string `locationName:"brokerId" type:"string"`

	// The name of the broker. This value must be unique in your AWS account, 1-50
	// characters long, must contain only letters, numbers, dashes, and underscores,
	// and must not contain whitespaces, brackets, wildcard characters, or special
	// characters.
	BrokerName *string `locationName:"brokerName" type:"string"`

	// The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED,
	// DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
	BrokerState BrokerState `locationName:"brokerState" type:"string" enum:"true"`

	// Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE,
	// ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker
	// in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby
	// broker for high availability.
	DeploymentMode DeploymentMode `locationName:"deploymentMode" type:"string" enum:"true"`

	// The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
	HostInstanceType *string `locationName:"hostInstanceType" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of the broker. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/BrokerSummary

func (BrokerSummary) GoString

func (s BrokerSummary) GoString() string

GoString returns the string representation

func (BrokerSummary) MarshalFields

func (s BrokerSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BrokerSummary) String

func (s BrokerSummary) String() string

String returns the string representation

type ChangeType

type ChangeType string

The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE

const (
	ChangeTypeCreate ChangeType = "CREATE"
	ChangeTypeUpdate ChangeType = "UPDATE"
	ChangeTypeDelete ChangeType = "DELETE"
)

Enum values for ChangeType

func (ChangeType) MarshalValue

func (enum ChangeType) MarshalValue() (string, error)

func (ChangeType) MarshalValueBuf

func (enum ChangeType) MarshalValueBuf(b []byte) ([]byte, error)

type Configuration

type Configuration struct {

	// Required. The ARN of the configuration.
	Arn *string `locationName:"arn" type:"string"`

	// Required. The description of the configuration.
	Description *string `locationName:"description" type:"string"`

	// Required. The type of broker engine. Note: Currently, Amazon MQ supports
	// only ACTIVEMQ.
	EngineType EngineType `locationName:"engineType" type:"string" enum:"true"`

	// Required. The version of the broker engine.
	EngineVersion *string `locationName:"engineVersion" type:"string"`

	// Required. The unique ID that Amazon MQ generates for the configuration.
	Id *string `locationName:"id" type:"string"`

	// Required. The latest revision of the configuration.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`

	// Required. The name of the configuration. This value can contain only alphanumeric
	// characters, dashes, periods, underscores, and tildes (- . _ ~). This value
	// must be 1-150 characters long.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Returns information about all configurations. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Configuration

func (Configuration) GoString

func (s Configuration) GoString() string

GoString returns the string representation

func (Configuration) MarshalFields

func (s Configuration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Configuration) String

func (s Configuration) String() string

String returns the string representation

type ConfigurationId

type ConfigurationId struct {

	// Required. The unique ID that Amazon MQ generates for the configuration.
	Id *string `locationName:"id" type:"string"`

	// The Universally Unique Identifier (UUID) of the request.
	Revision *int64 `locationName:"revision" type:"integer"`
	// contains filtered or unexported fields
}

A list of information about the configuration. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ConfigurationId

func (ConfigurationId) GoString

func (s ConfigurationId) GoString() string

GoString returns the string representation

func (ConfigurationId) MarshalFields

func (s ConfigurationId) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ConfigurationId) String

func (s ConfigurationId) String() string

String returns the string representation

type ConfigurationRevision

type ConfigurationRevision struct {

	// The description of the configuration revision.
	Description *string `locationName:"description" type:"string"`

	// Required. The revision of the configuration.
	Revision *int64 `locationName:"revision" type:"integer"`
	// contains filtered or unexported fields
}

Returns information about the specified configuration revision. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ConfigurationRevision

func (ConfigurationRevision) GoString

func (s ConfigurationRevision) GoString() string

GoString returns the string representation

func (ConfigurationRevision) MarshalFields

func (s ConfigurationRevision) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ConfigurationRevision) String

func (s ConfigurationRevision) String() string

String returns the string representation

type Configurations

type Configurations struct {

	// The current configuration of the broker.
	Current *ConfigurationId `locationName:"current" type:"structure"`

	// The history of configurations applied to the broker.
	History []ConfigurationId `locationName:"history" type:"list"`

	// The pending configuration of the broker.
	Pending *ConfigurationId `locationName:"pending" type:"structure"`
	// contains filtered or unexported fields
}

Broker configuration information Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Configurations

func (Configurations) GoString

func (s Configurations) GoString() string

GoString returns the string representation

func (Configurations) MarshalFields

func (s Configurations) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Configurations) String

func (s Configurations) String() string

String returns the string representation

type CreateBrokerInput

type CreateBrokerInput struct {
	AutoMinorVersionUpgrade *bool `locationName:"autoMinorVersionUpgrade" type:"boolean"`

	BrokerName *string `locationName:"brokerName" type:"string"`

	// A list of information about the configuration.
	Configuration *ConfigurationId `locationName:"configuration" type:"structure"`

	CreatorRequestId *string `locationName:"creatorRequestId" type:"string" idempotencyToken:"true"`

	// The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
	// SINGLE_INSTANCE creates a single-instance broker in a single Availability
	// Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
	DeploymentMode DeploymentMode `locationName:"deploymentMode" type:"string" enum:"true"`

	// The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.
	EngineType EngineType `locationName:"engineType" type:"string" enum:"true"`

	EngineVersion *string `locationName:"engineVersion" type:"string"`

	HostInstanceType *string `locationName:"hostInstanceType" type:"string"`

	// The scheduled time period relative to UTC during which Amazon MQ begins to
	// apply pending updates or patches to the broker.
	MaintenanceWindowStartTime *WeeklyStartTime `locationName:"maintenanceWindowStartTime" type:"structure"`

	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	SecurityGroups []string `locationName:"securityGroups" type:"list"`

	SubnetIds []string `locationName:"subnetIds" type:"list"`

	Users []User `locationName:"users" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerRequest

func (CreateBrokerInput) GoString

func (s CreateBrokerInput) GoString() string

GoString returns the string representation

func (CreateBrokerInput) MarshalFields

func (s CreateBrokerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateBrokerInput) String

func (s CreateBrokerInput) String() string

String returns the string representation

type CreateBrokerOutput

type CreateBrokerOutput struct {
	BrokerArn *string `locationName:"brokerArn" type:"string"`

	BrokerId *string `locationName:"brokerId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerResponse

func (CreateBrokerOutput) GoString

func (s CreateBrokerOutput) GoString() string

GoString returns the string representation

func (CreateBrokerOutput) MarshalFields

func (s CreateBrokerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateBrokerOutput) SDKResponseMetadata

func (s CreateBrokerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateBrokerOutput) String

func (s CreateBrokerOutput) String() string

String returns the string representation

type CreateBrokerRequest

type CreateBrokerRequest struct {
	*aws.Request
	Input *CreateBrokerInput
	Copy  func(*CreateBrokerInput) CreateBrokerRequest
}

CreateBrokerRequest is a API request type for the CreateBroker API operation.

func (CreateBrokerRequest) Send

Send marshals and sends the CreateBroker API request.

type CreateConfigurationInput

type CreateConfigurationInput struct {

	// The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.
	EngineType EngineType `locationName:"engineType" type:"string" enum:"true"`

	EngineVersion *string `locationName:"engineVersion" type:"string"`

	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfigurationRequest

func (CreateConfigurationInput) GoString

func (s CreateConfigurationInput) GoString() string

GoString returns the string representation

func (CreateConfigurationInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationInput) String

func (s CreateConfigurationInput) String() string

String returns the string representation

type CreateConfigurationOutput

type CreateConfigurationOutput struct {
	Arn *string `locationName:"arn" type:"string"`

	Id *string `locationName:"id" type:"string"`

	// Returns information about the specified configuration revision.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`

	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfigurationResponse

func (CreateConfigurationOutput) GoString

func (s CreateConfigurationOutput) GoString() string

GoString returns the string representation

func (CreateConfigurationOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateConfigurationOutput) SDKResponseMetadata

func (s CreateConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateConfigurationOutput) String

func (s CreateConfigurationOutput) String() string

String returns the string representation

type CreateConfigurationRequest

type CreateConfigurationRequest struct {
	*aws.Request
	Input *CreateConfigurationInput
	Copy  func(*CreateConfigurationInput) CreateConfigurationRequest
}

CreateConfigurationRequest is a API request type for the CreateConfiguration API operation.

func (CreateConfigurationRequest) Send

Send marshals and sends the CreateConfiguration API request.

type CreateUserInput

type CreateUserInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`

	ConsoleAccess *bool `locationName:"consoleAccess" type:"boolean"`

	Groups []string `locationName:"groups" type:"list"`

	Password *string `locationName:"password" type:"string"`

	// Username is a required field
	Username *string `location:"uri" locationName:"username" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserRequest

func (CreateUserInput) GoString

func (s CreateUserInput) GoString() string

GoString returns the string representation

func (CreateUserInput) MarshalFields

func (s CreateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateUserInput) String

func (s CreateUserInput) String() string

String returns the string representation

func (*CreateUserInput) Validate

func (s *CreateUserInput) Validate() error

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

type CreateUserOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserResponse

func (CreateUserOutput) GoString

func (s CreateUserOutput) GoString() string

GoString returns the string representation

func (CreateUserOutput) MarshalFields

func (s CreateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateUserOutput) SDKResponseMetadata

func (s CreateUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateUserOutput) String

func (s CreateUserOutput) String() string

String returns the string representation

type CreateUserRequest

type CreateUserRequest struct {
	*aws.Request
	Input *CreateUserInput
	Copy  func(*CreateUserInput) CreateUserRequest
}

CreateUserRequest is a API request type for the CreateUser API operation.

func (CreateUserRequest) Send

Send marshals and sends the CreateUser API request.

type DayOfWeek

type DayOfWeek string
const (
	DayOfWeekMonday    DayOfWeek = "MONDAY"
	DayOfWeekTuesday   DayOfWeek = "TUESDAY"
	DayOfWeekWednesday DayOfWeek = "WEDNESDAY"
	DayOfWeekThursday  DayOfWeek = "THURSDAY"
	DayOfWeekFriday    DayOfWeek = "FRIDAY"
	DayOfWeekSaturday  DayOfWeek = "SATURDAY"
	DayOfWeekSunday    DayOfWeek = "SUNDAY"
)

Enum values for DayOfWeek

func (DayOfWeek) MarshalValue

func (enum DayOfWeek) MarshalValue() (string, error)

func (DayOfWeek) MarshalValueBuf

func (enum DayOfWeek) MarshalValueBuf(b []byte) ([]byte, error)

type DeleteBrokerInput

type DeleteBrokerInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBrokerRequest

func (DeleteBrokerInput) GoString

func (s DeleteBrokerInput) GoString() string

GoString returns the string representation

func (DeleteBrokerInput) MarshalFields

func (s DeleteBrokerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBrokerInput) String

func (s DeleteBrokerInput) String() string

String returns the string representation

func (*DeleteBrokerInput) Validate

func (s *DeleteBrokerInput) Validate() error

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

type DeleteBrokerOutput

type DeleteBrokerOutput struct {
	BrokerId *string `locationName:"brokerId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBrokerResponse

func (DeleteBrokerOutput) GoString

func (s DeleteBrokerOutput) GoString() string

GoString returns the string representation

func (DeleteBrokerOutput) MarshalFields

func (s DeleteBrokerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteBrokerOutput) SDKResponseMetadata

func (s DeleteBrokerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteBrokerOutput) String

func (s DeleteBrokerOutput) String() string

String returns the string representation

type DeleteBrokerRequest

type DeleteBrokerRequest struct {
	*aws.Request
	Input *DeleteBrokerInput
	Copy  func(*DeleteBrokerInput) DeleteBrokerRequest
}

DeleteBrokerRequest is a API request type for the DeleteBroker API operation.

func (DeleteBrokerRequest) Send

Send marshals and sends the DeleteBroker API request.

type DeleteUserInput

type DeleteUserInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`

	// Username is a required field
	Username *string `location:"uri" locationName:"username" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUserRequest

func (DeleteUserInput) GoString

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (DeleteUserInput) MarshalFields

func (s DeleteUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteUserInput) String

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate

func (s *DeleteUserInput) Validate() error

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

type DeleteUserOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUserResponse

func (DeleteUserOutput) GoString

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (DeleteUserOutput) MarshalFields

func (s DeleteUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteUserOutput) SDKResponseMetadata

func (s DeleteUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteUserOutput) String

func (s DeleteUserOutput) String() string

String returns the string representation

type DeleteUserRequest

type DeleteUserRequest struct {
	*aws.Request
	Input *DeleteUserInput
	Copy  func(*DeleteUserInput) DeleteUserRequest
}

DeleteUserRequest is a API request type for the DeleteUser API operation.

func (DeleteUserRequest) Send

Send marshals and sends the DeleteUser API request.

type DeploymentMode

type DeploymentMode string

The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

const (
	DeploymentModeSingleInstance       DeploymentMode = "SINGLE_INSTANCE"
	DeploymentModeActiveStandbyMultiAz DeploymentMode = "ACTIVE_STANDBY_MULTI_AZ"
)

Enum values for DeploymentMode

func (DeploymentMode) MarshalValue

func (enum DeploymentMode) MarshalValue() (string, error)

func (DeploymentMode) MarshalValueBuf

func (enum DeploymentMode) MarshalValueBuf(b []byte) ([]byte, error)

type DescribeBrokerInput

type DescribeBrokerInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerRequest

func (DescribeBrokerInput) GoString

func (s DescribeBrokerInput) GoString() string

GoString returns the string representation

func (DescribeBrokerInput) MarshalFields

func (s DescribeBrokerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeBrokerInput) String

func (s DescribeBrokerInput) String() string

String returns the string representation

func (*DescribeBrokerInput) Validate

func (s *DescribeBrokerInput) Validate() error

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

type DescribeBrokerOutput

type DescribeBrokerOutput struct {
	AutoMinorVersionUpgrade *bool `locationName:"autoMinorVersionUpgrade" type:"boolean"`

	BrokerArn *string `locationName:"brokerArn" type:"string"`

	BrokerId *string `locationName:"brokerId" type:"string"`

	BrokerInstances []BrokerInstance `locationName:"brokerInstances" type:"list"`

	BrokerName *string `locationName:"brokerName" type:"string"`

	// The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED,
	// DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
	BrokerState BrokerState `locationName:"brokerState" type:"string" enum:"true"`

	// Broker configuration information
	Configurations *Configurations `locationName:"configurations" type:"structure"`

	// The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
	// SINGLE_INSTANCE creates a single-instance broker in a single Availability
	// Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
	DeploymentMode DeploymentMode `locationName:"deploymentMode" type:"string" enum:"true"`

	// The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.
	EngineType EngineType `locationName:"engineType" type:"string" enum:"true"`

	EngineVersion *string `locationName:"engineVersion" type:"string"`

	HostInstanceType *string `locationName:"hostInstanceType" type:"string"`

	// The scheduled time period relative to UTC during which Amazon MQ begins to
	// apply pending updates or patches to the broker.
	MaintenanceWindowStartTime *WeeklyStartTime `locationName:"maintenanceWindowStartTime" type:"structure"`

	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean"`

	SecurityGroups []string `locationName:"securityGroups" type:"list"`

	SubnetIds []string `locationName:"subnetIds" type:"list"`

	Users []UserSummary `locationName:"users" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerResponse

func (DescribeBrokerOutput) GoString

func (s DescribeBrokerOutput) GoString() string

GoString returns the string representation

func (DescribeBrokerOutput) MarshalFields

func (s DescribeBrokerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeBrokerOutput) SDKResponseMetadata

func (s DescribeBrokerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeBrokerOutput) String

func (s DescribeBrokerOutput) String() string

String returns the string representation

type DescribeBrokerRequest

type DescribeBrokerRequest struct {
	*aws.Request
	Input *DescribeBrokerInput
	Copy  func(*DescribeBrokerInput) DescribeBrokerRequest
}

DescribeBrokerRequest is a API request type for the DescribeBroker API operation.

func (DescribeBrokerRequest) Send

Send marshals and sends the DescribeBroker API request.

type DescribeConfigurationInput

type DescribeConfigurationInput struct {

	// ConfigurationId is a required field
	ConfigurationId *string `location:"uri" locationName:"configuration-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRequest

func (DescribeConfigurationInput) GoString

func (s DescribeConfigurationInput) GoString() string

GoString returns the string representation

func (DescribeConfigurationInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationInput) String

String returns the string representation

func (*DescribeConfigurationInput) Validate

func (s *DescribeConfigurationInput) Validate() error

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

type DescribeConfigurationOutput

type DescribeConfigurationOutput struct {
	Arn *string `locationName:"arn" type:"string"`

	Description *string `locationName:"description" type:"string"`

	// The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.
	EngineType EngineType `locationName:"engineType" type:"string" enum:"true"`

	EngineVersion *string `locationName:"engineVersion" type:"string"`

	Id *string `locationName:"id" type:"string"`

	// Returns information about the specified configuration revision.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`

	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationResponse

func (DescribeConfigurationOutput) GoString

func (s DescribeConfigurationOutput) GoString() string

GoString returns the string representation

func (DescribeConfigurationOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationOutput) SDKResponseMetadata

func (s DescribeConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeConfigurationOutput) String

String returns the string representation

type DescribeConfigurationRequest

type DescribeConfigurationRequest struct {
	*aws.Request
	Input *DescribeConfigurationInput
	Copy  func(*DescribeConfigurationInput) DescribeConfigurationRequest
}

DescribeConfigurationRequest is a API request type for the DescribeConfiguration API operation.

func (DescribeConfigurationRequest) Send

Send marshals and sends the DescribeConfiguration API request.

type DescribeConfigurationRevisionInput

type DescribeConfigurationRevisionInput struct {

	// ConfigurationId is a required field
	ConfigurationId *string `location:"uri" locationName:"configuration-id" type:"string" required:"true"`

	// ConfigurationRevision is a required field
	ConfigurationRevision *string `location:"uri" locationName:"configuration-revision" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevisionRequest

func (DescribeConfigurationRevisionInput) GoString

GoString returns the string representation

func (DescribeConfigurationRevisionInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationRevisionInput) String

String returns the string representation

func (*DescribeConfigurationRevisionInput) Validate

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

type DescribeConfigurationRevisionOutput

type DescribeConfigurationRevisionOutput struct {
	ConfigurationId *string `locationName:"configurationId" type:"string"`

	Data *string `locationName:"data" type:"string"`

	Description *string `locationName:"description" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevisionResponse

func (DescribeConfigurationRevisionOutput) GoString

GoString returns the string representation

func (DescribeConfigurationRevisionOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeConfigurationRevisionOutput) SDKResponseMetadata

func (s DescribeConfigurationRevisionOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeConfigurationRevisionOutput) String

String returns the string representation

type DescribeConfigurationRevisionRequest

type DescribeConfigurationRevisionRequest struct {
	*aws.Request
	Input *DescribeConfigurationRevisionInput
	Copy  func(*DescribeConfigurationRevisionInput) DescribeConfigurationRevisionRequest
}

DescribeConfigurationRevisionRequest is a API request type for the DescribeConfigurationRevision API operation.

func (DescribeConfigurationRevisionRequest) Send

Send marshals and sends the DescribeConfigurationRevision API request.

type DescribeUserInput

type DescribeUserInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`

	// Username is a required field
	Username *string `location:"uri" locationName:"username" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUserRequest

func (DescribeUserInput) GoString

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (DescribeUserInput) MarshalFields

func (s DescribeUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserInput) String

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate

func (s *DescribeUserInput) Validate() error

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

type DescribeUserOutput

type DescribeUserOutput struct {
	BrokerId *string `locationName:"brokerId" type:"string"`

	ConsoleAccess *bool `locationName:"consoleAccess" type:"boolean"`

	Groups []string `locationName:"groups" type:"list"`

	// Returns information about the status of the changes pending for the ActiveMQ
	// user.
	Pending *UserPendingChanges `locationName:"pending" type:"structure"`

	Username *string `locationName:"username" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUserResponse

func (DescribeUserOutput) GoString

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (DescribeUserOutput) MarshalFields

func (s DescribeUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeUserOutput) SDKResponseMetadata

func (s DescribeUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeUserOutput) String

func (s DescribeUserOutput) String() string

String returns the string representation

type DescribeUserRequest

type DescribeUserRequest struct {
	*aws.Request
	Input *DescribeUserInput
	Copy  func(*DescribeUserInput) DescribeUserRequest
}

DescribeUserRequest is a API request type for the DescribeUser API operation.

func (DescribeUserRequest) Send

Send marshals and sends the DescribeUser API request.

type EngineType

type EngineType string

The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.

const (
	EngineTypeActivemq EngineType = "ACTIVEMQ"
)

Enum values for EngineType

func (EngineType) MarshalValue

func (enum EngineType) MarshalValue() (string, error)

func (EngineType) MarshalValueBuf

func (enum EngineType) MarshalValueBuf(b []byte) ([]byte, error)

type ListBrokersInput

type ListBrokersInput struct {
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokersRequest

func (ListBrokersInput) GoString

func (s ListBrokersInput) GoString() string

GoString returns the string representation

func (ListBrokersInput) MarshalFields

func (s ListBrokersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBrokersInput) String

func (s ListBrokersInput) String() string

String returns the string representation

func (*ListBrokersInput) Validate

func (s *ListBrokersInput) Validate() error

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

type ListBrokersOutput

type ListBrokersOutput struct {
	BrokerSummaries []BrokerSummary `locationName:"brokerSummaries" type:"list"`

	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokersResponse

func (ListBrokersOutput) GoString

func (s ListBrokersOutput) GoString() string

GoString returns the string representation

func (ListBrokersOutput) MarshalFields

func (s ListBrokersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBrokersOutput) SDKResponseMetadata

func (s ListBrokersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListBrokersOutput) String

func (s ListBrokersOutput) String() string

String returns the string representation

type ListBrokersRequest

type ListBrokersRequest struct {
	*aws.Request
	Input *ListBrokersInput
	Copy  func(*ListBrokersInput) ListBrokersRequest
}

ListBrokersRequest is a API request type for the ListBrokers API operation.

func (ListBrokersRequest) Send

Send marshals and sends the ListBrokers API request.

type ListConfigurationRevisionsInput

type ListConfigurationRevisionsInput struct {

	// ConfigurationId is a required field
	ConfigurationId *string `location:"uri" locationName:"configuration-id" type:"string" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisionsRequest

func (ListConfigurationRevisionsInput) GoString

GoString returns the string representation

func (ListConfigurationRevisionsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationRevisionsInput) String

String returns the string representation

func (*ListConfigurationRevisionsInput) Validate

func (s *ListConfigurationRevisionsInput) Validate() error

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

type ListConfigurationRevisionsOutput

type ListConfigurationRevisionsOutput struct {
	ConfigurationId *string `locationName:"configurationId" type:"string"`

	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	NextToken *string `locationName:"nextToken" type:"string"`

	Revisions []ConfigurationRevision `locationName:"revisions" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisionsResponse

func (ListConfigurationRevisionsOutput) GoString

GoString returns the string representation

func (ListConfigurationRevisionsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationRevisionsOutput) SDKResponseMetadata

func (s ListConfigurationRevisionsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListConfigurationRevisionsOutput) String

String returns the string representation

type ListConfigurationRevisionsRequest

type ListConfigurationRevisionsRequest struct {
	*aws.Request
	Input *ListConfigurationRevisionsInput
	Copy  func(*ListConfigurationRevisionsInput) ListConfigurationRevisionsRequest
}

ListConfigurationRevisionsRequest is a API request type for the ListConfigurationRevisions API operation.

func (ListConfigurationRevisionsRequest) Send

Send marshals and sends the ListConfigurationRevisions API request.

type ListConfigurationsInput

type ListConfigurationsInput struct {
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationsRequest

func (ListConfigurationsInput) GoString

func (s ListConfigurationsInput) GoString() string

GoString returns the string representation

func (ListConfigurationsInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationsInput) String

func (s ListConfigurationsInput) String() string

String returns the string representation

func (*ListConfigurationsInput) Validate

func (s *ListConfigurationsInput) Validate() error

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

type ListConfigurationsOutput

type ListConfigurationsOutput struct {
	Configurations []Configuration `locationName:"configurations" type:"list"`

	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationsResponse

func (ListConfigurationsOutput) GoString

func (s ListConfigurationsOutput) GoString() string

GoString returns the string representation

func (ListConfigurationsOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListConfigurationsOutput) SDKResponseMetadata

func (s ListConfigurationsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListConfigurationsOutput) String

func (s ListConfigurationsOutput) String() string

String returns the string representation

type ListConfigurationsRequest

type ListConfigurationsRequest struct {
	*aws.Request
	Input *ListConfigurationsInput
	Copy  func(*ListConfigurationsInput) ListConfigurationsRequest
}

ListConfigurationsRequest is a API request type for the ListConfigurations API operation.

func (ListConfigurationsRequest) Send

Send marshals and sends the ListConfigurations API request.

type ListUsersInput

type ListUsersInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`

	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsersRequest

func (ListUsersInput) GoString

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (ListUsersInput) MarshalFields

func (s ListUsersInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUsersInput) String

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate

func (s *ListUsersInput) Validate() error

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

type ListUsersOutput

type ListUsersOutput struct {
	BrokerId *string `locationName:"brokerId" type:"string"`

	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	NextToken *string `locationName:"nextToken" type:"string"`

	Users []UserSummary `locationName:"users" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsersResponse

func (ListUsersOutput) GoString

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (ListUsersOutput) MarshalFields

func (s ListUsersOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListUsersOutput) SDKResponseMetadata

func (s ListUsersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListUsersOutput) String

func (s ListUsersOutput) String() string

String returns the string representation

type ListUsersRequest

type ListUsersRequest struct {
	*aws.Request
	Input *ListUsersInput
	Copy  func(*ListUsersInput) ListUsersRequest
}

ListUsersRequest is a API request type for the ListUsers API operation.

func (ListUsersRequest) Send

func (r ListUsersRequest) Send() (*ListUsersOutput, error)

Send marshals and sends the ListUsers API request.

type MQ

type MQ struct {
	*aws.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.

func New

func New(config aws.Config) *MQ

New creates a new instance of the MQ client with a config.

Example:

// Create a MQ client from just a config.
svc := mq.New(myConfig)

func (*MQ) CreateBrokerRequest

func (c *MQ) CreateBrokerRequest(input *CreateBrokerInput) CreateBrokerRequest

CreateBrokerRequest returns a request value for making API operation for AmazonMQ.

Creates a broker. Note: This API is asynchronous.

// Example sending a request using the CreateBrokerRequest method.
req := client.CreateBrokerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) CreateConfigurationRequest

func (c *MQ) CreateConfigurationRequest(input *CreateConfigurationInput) CreateConfigurationRequest

CreateConfigurationRequest returns a request value for making API operation for AmazonMQ.

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration.

// Example sending a request using the CreateConfigurationRequest method.
req := client.CreateConfigurationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) CreateUserRequest

func (c *MQ) CreateUserRequest(input *CreateUserInput) CreateUserRequest

CreateUserRequest returns a request value for making API operation for AmazonMQ.

Creates an ActiveMQ user.

// Example sending a request using the CreateUserRequest method.
req := client.CreateUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) DeleteBrokerRequest

func (c *MQ) DeleteBrokerRequest(input *DeleteBrokerInput) DeleteBrokerRequest

DeleteBrokerRequest returns a request value for making API operation for AmazonMQ.

Deletes a broker. Note: This API is asynchronous.

// Example sending a request using the DeleteBrokerRequest method.
req := client.DeleteBrokerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) DeleteUserRequest

func (c *MQ) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest

DeleteUserRequest returns a request value for making API operation for AmazonMQ.

Deletes an ActiveMQ user.

// Example sending a request using the DeleteUserRequest method.
req := client.DeleteUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) DescribeBrokerRequest

func (c *MQ) DescribeBrokerRequest(input *DescribeBrokerInput) DescribeBrokerRequest

DescribeBrokerRequest returns a request value for making API operation for AmazonMQ.

Returns information about the specified broker.

// Example sending a request using the DescribeBrokerRequest method.
req := client.DescribeBrokerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) DescribeConfigurationRequest

func (c *MQ) DescribeConfigurationRequest(input *DescribeConfigurationInput) DescribeConfigurationRequest

DescribeConfigurationRequest returns a request value for making API operation for AmazonMQ.

Returns information about the specified configuration.

// Example sending a request using the DescribeConfigurationRequest method.
req := client.DescribeConfigurationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) DescribeConfigurationRevisionRequest

func (c *MQ) DescribeConfigurationRevisionRequest(input *DescribeConfigurationRevisionInput) DescribeConfigurationRevisionRequest

DescribeConfigurationRevisionRequest returns a request value for making API operation for AmazonMQ.

Returns the specified configuration revision for the specified configuration.

// Example sending a request using the DescribeConfigurationRevisionRequest method.
req := client.DescribeConfigurationRevisionRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) DescribeUserRequest

func (c *MQ) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest

DescribeUserRequest returns a request value for making API operation for AmazonMQ.

Returns information about an ActiveMQ user.

// Example sending a request using the DescribeUserRequest method.
req := client.DescribeUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) ListBrokersRequest

func (c *MQ) ListBrokersRequest(input *ListBrokersInput) ListBrokersRequest

ListBrokersRequest returns a request value for making API operation for AmazonMQ.

Returns a list of all brokers.

// Example sending a request using the ListBrokersRequest method.
req := client.ListBrokersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) ListConfigurationRevisionsRequest

func (c *MQ) ListConfigurationRevisionsRequest(input *ListConfigurationRevisionsInput) ListConfigurationRevisionsRequest

ListConfigurationRevisionsRequest returns a request value for making API operation for AmazonMQ.

Returns a list of all revisions for the specified configuration.

// Example sending a request using the ListConfigurationRevisionsRequest method.
req := client.ListConfigurationRevisionsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) ListConfigurationsRequest

func (c *MQ) ListConfigurationsRequest(input *ListConfigurationsInput) ListConfigurationsRequest

ListConfigurationsRequest returns a request value for making API operation for AmazonMQ.

Returns a list of all configurations.

// Example sending a request using the ListConfigurationsRequest method.
req := client.ListConfigurationsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) ListUsersRequest

func (c *MQ) ListUsersRequest(input *ListUsersInput) ListUsersRequest

ListUsersRequest returns a request value for making API operation for AmazonMQ.

Returns a list of all ActiveMQ users.

// Example sending a request using the ListUsersRequest method.
req := client.ListUsersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) RebootBrokerRequest

func (c *MQ) RebootBrokerRequest(input *RebootBrokerInput) RebootBrokerRequest

RebootBrokerRequest returns a request value for making API operation for AmazonMQ.

Reboots a broker. Note: This API is asynchronous.

// Example sending a request using the RebootBrokerRequest method.
req := client.RebootBrokerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) UpdateBrokerRequest

func (c *MQ) UpdateBrokerRequest(input *UpdateBrokerInput) UpdateBrokerRequest

UpdateBrokerRequest returns a request value for making API operation for AmazonMQ.

Adds a pending configuration change to a broker.

// Example sending a request using the UpdateBrokerRequest method.
req := client.UpdateBrokerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) UpdateConfigurationRequest

func (c *MQ) UpdateConfigurationRequest(input *UpdateConfigurationInput) UpdateConfigurationRequest

UpdateConfigurationRequest returns a request value for making API operation for AmazonMQ.

Updates the specified configuration.

// Example sending a request using the UpdateConfigurationRequest method.
req := client.UpdateConfigurationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

func (*MQ) UpdateUserRequest

func (c *MQ) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest

UpdateUserRequest returns a request value for making API operation for AmazonMQ.

Updates the information for an ActiveMQ user.

// Example sending a request using the UpdateUserRequest method.
req := client.UpdateUserRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

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

type RebootBrokerInput

type RebootBrokerInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBrokerRequest

func (RebootBrokerInput) GoString

func (s RebootBrokerInput) GoString() string

GoString returns the string representation

func (RebootBrokerInput) MarshalFields

func (s RebootBrokerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RebootBrokerInput) String

func (s RebootBrokerInput) String() string

String returns the string representation

func (*RebootBrokerInput) Validate

func (s *RebootBrokerInput) Validate() error

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

type RebootBrokerOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBrokerResponse

func (RebootBrokerOutput) GoString

func (s RebootBrokerOutput) GoString() string

GoString returns the string representation

func (RebootBrokerOutput) MarshalFields

func (s RebootBrokerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (RebootBrokerOutput) SDKResponseMetadata

func (s RebootBrokerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (RebootBrokerOutput) String

func (s RebootBrokerOutput) String() string

String returns the string representation

type RebootBrokerRequest

type RebootBrokerRequest struct {
	*aws.Request
	Input *RebootBrokerInput
	Copy  func(*RebootBrokerInput) RebootBrokerRequest
}

RebootBrokerRequest is a API request type for the RebootBroker API operation.

func (RebootBrokerRequest) Send

Send marshals and sends the RebootBroker API request.

type SanitizationWarning

type SanitizationWarning struct {

	// The name of the XML attribute that has been sanitized.
	AttributeName *string `locationName:"attributeName" type:"string"`

	// The name of the XML element that has been sanitized.
	ElementName *string `locationName:"elementName" type:"string"`

	// Required. The reason for which the XML elements or attributes were sanitized.
	// Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED,
	// INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the
	// provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED
	// shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED
	// shows that the provided value for the attribute isn't allowed and has been
	// removed.
	Reason SanitizationWarningReason `locationName:"reason" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Returns information about the XML element or attribute that was sanitized in the configuration. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/SanitizationWarning

func (SanitizationWarning) GoString

func (s SanitizationWarning) GoString() string

GoString returns the string representation

func (SanitizationWarning) MarshalFields

func (s SanitizationWarning) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SanitizationWarning) String

func (s SanitizationWarning) String() string

String returns the string representation

type SanitizationWarningReason

type SanitizationWarningReason string

The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.

const (
	SanitizationWarningReasonDisallowedElementRemoved     SanitizationWarningReason = "DISALLOWED_ELEMENT_REMOVED"
	SanitizationWarningReasonDisallowedAttributeRemoved   SanitizationWarningReason = "DISALLOWED_ATTRIBUTE_REMOVED"
	SanitizationWarningReasonInvalidAttributeValueRemoved SanitizationWarningReason = "INVALID_ATTRIBUTE_VALUE_REMOVED"
)

Enum values for SanitizationWarningReason

func (SanitizationWarningReason) MarshalValue

func (enum SanitizationWarningReason) MarshalValue() (string, error)

func (SanitizationWarningReason) MarshalValueBuf

func (enum SanitizationWarningReason) MarshalValueBuf(b []byte) ([]byte, error)

type UpdateBrokerInput

type UpdateBrokerInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`

	// A list of information about the configuration.
	Configuration *ConfigurationId `locationName:"configuration" type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerRequest

func (UpdateBrokerInput) GoString

func (s UpdateBrokerInput) GoString() string

GoString returns the string representation

func (UpdateBrokerInput) MarshalFields

func (s UpdateBrokerInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBrokerInput) String

func (s UpdateBrokerInput) String() string

String returns the string representation

func (*UpdateBrokerInput) Validate

func (s *UpdateBrokerInput) Validate() error

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

type UpdateBrokerOutput

type UpdateBrokerOutput struct {
	BrokerId *string `locationName:"brokerId" type:"string"`

	// A list of information about the configuration.
	Configuration *ConfigurationId `locationName:"configuration" type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerResponse

func (UpdateBrokerOutput) GoString

func (s UpdateBrokerOutput) GoString() string

GoString returns the string representation

func (UpdateBrokerOutput) MarshalFields

func (s UpdateBrokerOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateBrokerOutput) SDKResponseMetadata

func (s UpdateBrokerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateBrokerOutput) String

func (s UpdateBrokerOutput) String() string

String returns the string representation

type UpdateBrokerRequest

type UpdateBrokerRequest struct {
	*aws.Request
	Input *UpdateBrokerInput
	Copy  func(*UpdateBrokerInput) UpdateBrokerRequest
}

UpdateBrokerRequest is a API request type for the UpdateBroker API operation.

func (UpdateBrokerRequest) Send

Send marshals and sends the UpdateBroker API request.

type UpdateConfigurationInput

type UpdateConfigurationInput struct {

	// ConfigurationId is a required field
	ConfigurationId *string `location:"uri" locationName:"configuration-id" type:"string" required:"true"`

	Data *string `locationName:"data" type:"string"`

	Description *string `locationName:"description" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationRequest

func (UpdateConfigurationInput) GoString

func (s UpdateConfigurationInput) GoString() string

GoString returns the string representation

func (UpdateConfigurationInput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateConfigurationInput) String

func (s UpdateConfigurationInput) String() string

String returns the string representation

func (*UpdateConfigurationInput) Validate

func (s *UpdateConfigurationInput) Validate() error

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

type UpdateConfigurationOutput

type UpdateConfigurationOutput struct {
	Arn *string `locationName:"arn" type:"string"`

	Id *string `locationName:"id" type:"string"`

	// Returns information about the specified configuration revision.
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure"`

	Name *string `locationName:"name" type:"string"`

	Warnings []SanitizationWarning `locationName:"warnings" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationResponse

func (UpdateConfigurationOutput) GoString

func (s UpdateConfigurationOutput) GoString() string

GoString returns the string representation

func (UpdateConfigurationOutput) MarshalFields

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateConfigurationOutput) SDKResponseMetadata

func (s UpdateConfigurationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateConfigurationOutput) String

func (s UpdateConfigurationOutput) String() string

String returns the string representation

type UpdateConfigurationRequest

type UpdateConfigurationRequest struct {
	*aws.Request
	Input *UpdateConfigurationInput
	Copy  func(*UpdateConfigurationInput) UpdateConfigurationRequest
}

UpdateConfigurationRequest is a API request type for the UpdateConfiguration API operation.

func (UpdateConfigurationRequest) Send

Send marshals and sends the UpdateConfiguration API request.

type UpdateUserInput

type UpdateUserInput struct {

	// BrokerId is a required field
	BrokerId *string `location:"uri" locationName:"broker-id" type:"string" required:"true"`

	ConsoleAccess *bool `locationName:"consoleAccess" type:"boolean"`

	Groups []string `locationName:"groups" type:"list"`

	Password *string `locationName:"password" type:"string"`

	// Username is a required field
	Username *string `location:"uri" locationName:"username" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserRequest

func (UpdateUserInput) GoString

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (UpdateUserInput) MarshalFields

func (s UpdateUserInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserInput) String

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate

func (s *UpdateUserInput) Validate() error

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

type UpdateUserOutput

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserResponse

func (UpdateUserOutput) GoString

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

func (UpdateUserOutput) MarshalFields

func (s UpdateUserOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateUserOutput) SDKResponseMetadata

func (s UpdateUserOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateUserOutput) String

func (s UpdateUserOutput) String() string

String returns the string representation

type UpdateUserRequest

type UpdateUserRequest struct {
	*aws.Request
	Input *UpdateUserInput
	Copy  func(*UpdateUserInput) UpdateUserRequest
}

UpdateUserRequest is a API request type for the UpdateUser API operation.

func (UpdateUserRequest) Send

Send marshals and sends the UpdateUser API request.

type User

type User struct {

	// Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
	ConsoleAccess *bool `locationName:"consoleAccess" type:"boolean"`

	// The list of groups (20 maximum) to which the ActiveMQ user belongs. This
	// value can contain only alphanumeric characters, dashes, periods, underscores,
	// and tildes (- . _ ~). This value must be 2-100 characters long.
	Groups []string `locationName:"groups" type:"list"`

	// Required. The password of the ActiveMQ user. This value must be at least
	// 12 characters long, must contain at least 4 unique characters, and must not
	// contain commas.
	Password *string `locationName:"password" type:"string"`

	// Required. The username of the ActiveMQ user. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _
	// ~). This value must be 2-100 characters long.
	Username *string `locationName:"username" type:"string"`
	// contains filtered or unexported fields
}

An ActiveMQ user associated with the broker. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/User

func (User) GoString

func (s User) GoString() string

GoString returns the string representation

func (User) MarshalFields

func (s User) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (User) String

func (s User) String() string

String returns the string representation

type UserPendingChanges

type UserPendingChanges struct {

	// Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
	ConsoleAccess *bool `locationName:"consoleAccess" type:"boolean"`

	// The list of groups (20 maximum) to which the ActiveMQ user belongs. This
	// value can contain only alphanumeric characters, dashes, periods, underscores,
	// and tildes (- . _ ~). This value must be 2-100 characters long.
	Groups []string `locationName:"groups" type:"list"`

	// Required. The type of change pending for the ActiveMQ user. Possible values:
	// CREATE, UPDATE, DELETE
	PendingChange ChangeType `locationName:"pendingChange" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Returns information about the status of the changes pending for the ActiveMQ user. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UserPendingChanges

func (UserPendingChanges) GoString

func (s UserPendingChanges) GoString() string

GoString returns the string representation

func (UserPendingChanges) MarshalFields

func (s UserPendingChanges) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserPendingChanges) String

func (s UserPendingChanges) String() string

String returns the string representation

type UserSummary

type UserSummary struct {

	// The type of change pending for the ActiveMQ user. Possible values: CREATE,
	// UPDATE, DELETE
	PendingChange ChangeType `locationName:"pendingChange" type:"string" enum:"true"`

	// Required. The username of the ActiveMQ user. This value can contain only
	// alphanumeric characters, dashes, periods, underscores, and tildes (- . _
	// ~). This value must be 2-100 characters long.
	Username *string `locationName:"username" type:"string"`
	// contains filtered or unexported fields
}

Returns a list of all ActiveMQ users. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UserSummary

func (UserSummary) GoString

func (s UserSummary) GoString() string

GoString returns the string representation

func (UserSummary) MarshalFields

func (s UserSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserSummary) String

func (s UserSummary) String() string

String returns the string representation

type WeeklyStartTime

type WeeklyStartTime struct {

	// Required. The day of the week. Possible values: MONDAY, TUESDAY, WEDNESDAY,
	// THURSDAY, FRIDAY, SATURDAY, SUNDAY
	DayOfWeek DayOfWeek `locationName:"dayOfWeek" type:"string" enum:"true"`

	// Required. The time, in 24-hour format.
	TimeOfDay *string `locationName:"timeOfDay" type:"string"`

	// The time zone, UTC by default, in either the Country/City format, or the
	// UTC offset format.
	TimeZone *string `locationName:"timeZone" type:"string"`
	// contains filtered or unexported fields
}

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker. Please also see https://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/WeeklyStartTime

func (WeeklyStartTime) GoString

func (s WeeklyStartTime) GoString() string

GoString returns the string representation

func (WeeklyStartTime) MarshalFields

func (s WeeklyStartTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (WeeklyStartTime) String

func (s WeeklyStartTime) String() string

String returns the string representation

Directories

Path Synopsis
Package mqiface provides an interface to enable mocking the AmazonMQ service client for testing your code.
Package mqiface provides an interface to enable mocking the AmazonMQ service client for testing your code.

Jump to

Keyboard shortcuts

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