mq

package
v1.44.42 Latest Latest
Warning

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

 Go to latest Published: Jun 24, 2022 License: Apache-2.0 Imports: 10 Imported by: 109

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 and RabbitMQ 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 contact 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 (
	// AuthenticationStrategySimple is a AuthenticationStrategy enum value
	AuthenticationStrategySimple = "SIMPLE"

	// AuthenticationStrategyLdap is a AuthenticationStrategy enum value
	AuthenticationStrategyLdap = "LDAP"
)

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

View Source 
const (
	// BrokerStateCreationInProgress is a BrokerState enum value
	BrokerStateCreationInProgress = "CREATION_IN_PROGRESS"

	// BrokerStateCreationFailed is a BrokerState enum value
	BrokerStateCreationFailed = "CREATION_FAILED"

	// BrokerStateDeletionInProgress is a BrokerState enum value
	BrokerStateDeletionInProgress = "DELETION_IN_PROGRESS"

	// BrokerStateRunning is a BrokerState enum value
	BrokerStateRunning = "RUNNING"

	// BrokerStateRebootInProgress is a BrokerState enum value
	BrokerStateRebootInProgress = "REBOOT_IN_PROGRESS"

	// BrokerStateCriticalActionRequired is a BrokerState enum value
	BrokerStateCriticalActionRequired = "CRITICAL_ACTION_REQUIRED"
)

The broker's status.

View Source 
const (
	// BrokerStorageTypeEbs is a BrokerStorageType enum value
	BrokerStorageTypeEbs = "EBS"

	// BrokerStorageTypeEfs is a BrokerStorageType enum value
	BrokerStorageTypeEfs = "EFS"
)

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

View Source 
const (
	// ChangeTypeCreate is a ChangeType enum value
	ChangeTypeCreate = "CREATE"

	// ChangeTypeUpdate is a ChangeType enum value
	ChangeTypeUpdate = "UPDATE"

	// ChangeTypeDelete is a ChangeType enum value
	ChangeTypeDelete = "DELETE"
)

The type of change pending for the ActiveMQ user.

View Source 
const (
	// DayOfWeekMonday is a DayOfWeek enum value
	DayOfWeekMonday = "MONDAY"

	// DayOfWeekTuesday is a DayOfWeek enum value
	DayOfWeekTuesday = "TUESDAY"

	// DayOfWeekWednesday is a DayOfWeek enum value
	DayOfWeekWednesday = "WEDNESDAY"

	// DayOfWeekThursday is a DayOfWeek enum value
	DayOfWeekThursday = "THURSDAY"

	// DayOfWeekFriday is a DayOfWeek enum value
	DayOfWeekFriday = "FRIDAY"

	// DayOfWeekSaturday is a DayOfWeek enum value
	DayOfWeekSaturday = "SATURDAY"

	// DayOfWeekSunday is a DayOfWeek enum value
	DayOfWeekSunday = "SUNDAY"
)
View Source 
const (
	// DeploymentModeSingleInstance is a DeploymentMode enum value
	DeploymentModeSingleInstance = "SINGLE_INSTANCE"

	// DeploymentModeActiveStandbyMultiAz is a DeploymentMode enum value
	DeploymentModeActiveStandbyMultiAz = "ACTIVE_STANDBY_MULTI_AZ"

	// DeploymentModeClusterMultiAz is a DeploymentMode enum value
	DeploymentModeClusterMultiAz = "CLUSTER_MULTI_AZ"
)

The broker's deployment mode.

View Source 
const (
	// EngineTypeActivemq is a EngineType enum value
	EngineTypeActivemq = "ACTIVEMQ"

	// EngineTypeRabbitmq is a EngineType enum value
	EngineTypeRabbitmq = "RABBITMQ"
)

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

View Source 
const (
	// SanitizationWarningReasonDisallowedElementRemoved is a SanitizationWarningReason enum value
	SanitizationWarningReasonDisallowedElementRemoved = "DISALLOWED_ELEMENT_REMOVED"

	// SanitizationWarningReasonDisallowedAttributeRemoved is a SanitizationWarningReason enum value
	SanitizationWarningReasonDisallowedAttributeRemoved = "DISALLOWED_ATTRIBUTE_REMOVED"

	// SanitizationWarningReasonInvalidAttributeValueRemoved is a SanitizationWarningReason enum value
	SanitizationWarningReasonInvalidAttributeValueRemoved = "INVALID_ATTRIBUTE_VALUE_REMOVED"
)

The reason for which the XML elements or attributes were sanitized.

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"        // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "mq"        // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AuthenticationStrategy_Values added in v1.34.3 

func AuthenticationStrategy_Values() []string

AuthenticationStrategy_Values returns all elements of the AuthenticationStrategy enum

func BrokerState_Values added in v1.34.3 

func BrokerState_Values() []string

BrokerState_Values returns all elements of the BrokerState enum

func BrokerStorageType_Values added in v1.34.3 

func BrokerStorageType_Values() []string

BrokerStorageType_Values returns all elements of the BrokerStorageType enum

func ChangeType_Values added in v1.34.3 

func ChangeType_Values() []string

ChangeType_Values returns all elements of the ChangeType enum

func DayOfWeek_Values added in v1.34.3 

func DayOfWeek_Values() []string

DayOfWeek_Values returns all elements of the DayOfWeek enum

func DeploymentMode_Values added in v1.34.3 

func DeploymentMode_Values() []string

DeploymentMode_Values returns all elements of the DeploymentMode enum

func EngineType_Values added in v1.34.3 

func EngineType_Values() []string

EngineType_Values returns all elements of the EngineType enum

func SanitizationWarningReason_Values added in v1.34.3 

func SanitizationWarningReason_Values() []string

SanitizationWarningReason_Values returns all elements of the SanitizationWarningReason enum

Types

type ActionRequired added in v1.44.0 

type ActionRequired struct {

	// The code you can use to resolve your broker issue when the broker is in a
	// CRITICAL_ACTION_REQUIRED state. You can find instructions by choosing the
	// link for your code from the list of action required codes in Amazon MQ action
	// required codes (https://docs.aws.amazon.com//latest/developer-guide/troubleshooting-action-required-codes.html).
	// Each code references a topic with detailed information, instructions, and
	// recommendations for how to resolve the issue and prevent future occurrences.
	ActionRequiredCode *string `locationName:"actionRequiredCode" type:"string"`

	// Information about the action required to resolve your broker issue when the
	// broker is in a CRITICAL_ACTION_REQUIRED state.
	ActionRequiredInfo *string `locationName:"actionRequiredInfo" type:"string"`
	// contains filtered or unexported fields
}

The action required to resolve a broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.

func (ActionRequired) GoString added in v1.44.0 

func (s ActionRequired) GoString() string

GoString returns the string representation.

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

func (*ActionRequired) SetActionRequiredCode added in v1.44.0 

func (s *ActionRequired) SetActionRequiredCode(v string) *ActionRequired

SetActionRequiredCode sets the ActionRequiredCode field's value.

func (*ActionRequired) SetActionRequiredInfo added in v1.44.0 

func (s *ActionRequired) SetActionRequiredInfo(v string) *ActionRequired

SetActionRequiredInfo sets the ActionRequiredInfo field's value.

func (ActionRequired) String added in v1.44.0 

func (s ActionRequired) String() string

String returns the string representation.

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

type AvailabilityZone added in v1.19.12 

type AvailabilityZone struct {

	// Id for the availability zone.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Name of the availability zone.

func (AvailabilityZone) GoString added in v1.19.12 

func (s AvailabilityZone) GoString() string

GoString returns the string representation.

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

func (*AvailabilityZone) SetName added in v1.19.12 

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

SetName sets the Name field's value.

func (AvailabilityZone) String added in v1.19.12 

func (s AvailabilityZone) String() string

String returns the string representation.

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

type BadRequestException added in v1.28.0 

type BadRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorAttribute *string `locationName:"errorAttribute" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*BadRequestException) Code added in v1.28.0 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error added in v1.28.0 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString added in v1.28.0 

func (s BadRequestException) GoString() string

GoString returns the string representation.

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

func (*BadRequestException) Message added in v1.28.0 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr added in v1.28.0 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0 

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String added in v1.28.0 

func (s BadRequestException) String() string

String returns the string representation.

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

type BrokerEngineType added in v1.19.12 

type BrokerEngineType struct {

	// The broker's engine type.
	EngineType *string `locationName:"engineType" type:"string" enum:"EngineType"`

	// The list of engine versions.
	EngineVersions []*EngineVersion `locationName:"engineVersions" type:"list"`
	// contains filtered or unexported fields
}

Types of broker engines.

func (BrokerEngineType) GoString added in v1.19.12 

func (s BrokerEngineType) GoString() string

GoString returns the string representation.

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

func (*BrokerEngineType) SetEngineType added in v1.19.12 

func (s *BrokerEngineType) SetEngineType(v string) *BrokerEngineType

SetEngineType sets the EngineType field's value.

func (*BrokerEngineType) SetEngineVersions added in v1.19.12 

func (s *BrokerEngineType) SetEngineVersions(v []*EngineVersion) *BrokerEngineType

SetEngineVersions sets the EngineVersions field's value.

func (BrokerEngineType) String added in v1.19.12 

func (s BrokerEngineType) String() string

String returns the string representation.

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

type BrokerInstance 

type BrokerInstance struct {

	// The brokers web console URL.
	ConsoleURL *string `locationName:"consoleURL" type:"string"`

	// The broker's wire-level protocol endpoints.
	Endpoints []*string `locationName:"endpoints" type:"list"`

	// The IP address of the Elastic Network Interface (ENI) attached to the broker.
	// Does not apply to RabbitMQ brokers.
	IpAddress *string `locationName:"ipAddress" type:"string"`
	// contains filtered or unexported fields
}

Returns information about all brokers.

func (BrokerInstance) GoString 

func (s BrokerInstance) GoString() string

GoString returns the string representation.

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

func (*BrokerInstance) SetConsoleURL 

func (s *BrokerInstance) SetConsoleURL(v string) *BrokerInstance

SetConsoleURL sets the ConsoleURL field's value.

func (*BrokerInstance) SetEndpoints 

func (s *BrokerInstance) SetEndpoints(v []*string) *BrokerInstance

SetEndpoints sets the Endpoints field's value.

func (*BrokerInstance) SetIpAddress added in v1.15.1 

func (s *BrokerInstance) SetIpAddress(v string) *BrokerInstance

SetIpAddress sets the IpAddress field's value.

func (BrokerInstance) String 

func (s BrokerInstance) String() string

String returns the string representation.

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

type BrokerInstanceOption added in v1.19.12 

type BrokerInstanceOption struct {

	// The list of available az.
	AvailabilityZones []*AvailabilityZone `locationName:"availabilityZones" type:"list"`

	// The broker's engine type.
	EngineType *string `locationName:"engineType" type:"string" enum:"EngineType"`

	// The broker's instance type.
	HostInstanceType *string `locationName:"hostInstanceType" type:"string"`

	// The broker's storage type.
	StorageType *string `locationName:"storageType" type:"string" enum:"BrokerStorageType"`

	// The list of supported deployment modes.
	SupportedDeploymentModes []*string `locationName:"supportedDeploymentModes" type:"list" enum:"DeploymentMode"`

	// The list of supported engine versions.
	SupportedEngineVersions []*string `locationName:"supportedEngineVersions" type:"list"`
	// contains filtered or unexported fields
}

Option for host instance type.

func (BrokerInstanceOption) GoString added in v1.19.12 

func (s BrokerInstanceOption) GoString() string

GoString returns the string representation.

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

func (*BrokerInstanceOption) SetAvailabilityZones added in v1.19.12 

func (s *BrokerInstanceOption) SetAvailabilityZones(v []*AvailabilityZone) *BrokerInstanceOption

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*BrokerInstanceOption) SetEngineType added in v1.19.12 

func (s *BrokerInstanceOption) SetEngineType(v string) *BrokerInstanceOption

SetEngineType sets the EngineType field's value.

func (*BrokerInstanceOption) SetHostInstanceType added in v1.19.12 

func (s *BrokerInstanceOption) SetHostInstanceType(v string) *BrokerInstanceOption

SetHostInstanceType sets the HostInstanceType field's value.

func (*BrokerInstanceOption) SetStorageType added in v1.26.3 

func (s *BrokerInstanceOption) SetStorageType(v string) *BrokerInstanceOption

SetStorageType sets the StorageType field's value.

func (*BrokerInstanceOption) SetSupportedDeploymentModes added in v1.26.3 

func (s *BrokerInstanceOption) SetSupportedDeploymentModes(v []*string) *BrokerInstanceOption

SetSupportedDeploymentModes sets the SupportedDeploymentModes field's value.

func (*BrokerInstanceOption) SetSupportedEngineVersions added in v1.19.12 

func (s *BrokerInstanceOption) SetSupportedEngineVersions(v []*string) *BrokerInstanceOption

SetSupportedEngineVersions sets the SupportedEngineVersions field's value.

func (BrokerInstanceOption) String added in v1.19.12 

func (s BrokerInstanceOption) String() string

String returns the string representation.

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

type BrokerSummary 

type BrokerSummary struct {

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

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

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

	// The broker's status.
	BrokerState *string `locationName:"brokerState" type:"string" enum:"BrokerState"`

	// The time when the broker was created.
	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601"`

	// The broker's deployment mode.
	//
	// DeploymentMode is a required field
	DeploymentMode *string `locationName:"deploymentMode" type:"string" required:"true" enum:"DeploymentMode"`

	// The type of broker engine.
	//
	// EngineType is a required field
	EngineType *string `locationName:"engineType" type:"string" required:"true" enum:"EngineType"`

	// The broker's instance type.
	HostInstanceType *string `locationName:"hostInstanceType" type:"string"`
	// contains filtered or unexported fields
}

Returns information about all brokers.

func (BrokerSummary) GoString 

func (s BrokerSummary) GoString() string

GoString returns the string representation.

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

func (*BrokerSummary) SetBrokerArn 

func (s *BrokerSummary) SetBrokerArn(v string) *BrokerSummary

SetBrokerArn sets the BrokerArn field's value.

func (*BrokerSummary) SetBrokerId 

func (s *BrokerSummary) SetBrokerId(v string) *BrokerSummary

SetBrokerId sets the BrokerId field's value.

func (*BrokerSummary) SetBrokerName 

func (s *BrokerSummary) SetBrokerName(v string) *BrokerSummary

SetBrokerName sets the BrokerName field's value.

func (*BrokerSummary) SetBrokerState 

func (s *BrokerSummary) SetBrokerState(v string) *BrokerSummary

SetBrokerState sets the BrokerState field's value.

func (*BrokerSummary) SetCreated added in v1.15.1 

func (s *BrokerSummary) SetCreated(v time.Time) *BrokerSummary

SetCreated sets the Created field's value.

func (*BrokerSummary) SetDeploymentMode 

func (s *BrokerSummary) SetDeploymentMode(v string) *BrokerSummary

SetDeploymentMode sets the DeploymentMode field's value.

func (*BrokerSummary) SetEngineType added in v1.35.21 

func (s *BrokerSummary) SetEngineType(v string) *BrokerSummary

SetEngineType sets the EngineType field's value.

func (*BrokerSummary) SetHostInstanceType 

func (s *BrokerSummary) SetHostInstanceType(v string) *BrokerSummary

SetHostInstanceType sets the HostInstanceType field's value.

func (BrokerSummary) String 

func (s BrokerSummary) String() string

String returns the string representation.

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

type Configuration 

type Configuration struct {

	// Required. The ARN of the configuration.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// Optional. The authentication strategy associated with the configuration.
	// The default is SIMPLE.
	//
	// AuthenticationStrategy is a required field
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" required:"true" enum:"AuthenticationStrategy"`

	// Required. The date and time of the configuration revision.
	//
	// Created is a required field
	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Required. The description of the configuration.
	//
	// Description is a required field
	Description *string `locationName:"description" type:"string" required:"true"`

	// Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ
	// and RABBITMQ.
	//
	// EngineType is a required field
	EngineType *string `locationName:"engineType" type:"string" required:"true" enum:"EngineType"`

	// Required. The broker engine's version. For a list of supported engine versions,
	// see, Supported engines (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html).
	//
	// EngineVersion is a required field
	EngineVersion *string `locationName:"engineVersion" type:"string" required:"true"`

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

	// Required. The latest revision of the configuration.
	//
	// LatestRevision is a required field
	LatestRevision *ConfigurationRevision `locationName:"latestRevision" type:"structure" required:"true"`

	// 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 is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The list of all tags associated with this configuration.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Returns information about all configurations.

func (Configuration) GoString 

func (s Configuration) GoString() string

GoString returns the string representation.

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

func (*Configuration) SetArn 

func (s *Configuration) SetArn(v string) *Configuration

SetArn sets the Arn field's value.

func (*Configuration) SetAuthenticationStrategy added in v1.33.12 

func (s *Configuration) SetAuthenticationStrategy(v string) *Configuration

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*Configuration) SetCreated added in v1.15.1 

func (s *Configuration) SetCreated(v time.Time) *Configuration

SetCreated sets the Created field's value.

func (*Configuration) SetDescription 

func (s *Configuration) SetDescription(v string) *Configuration

SetDescription sets the Description field's value.

func (*Configuration) SetEngineType 

func (s *Configuration) SetEngineType(v string) *Configuration

SetEngineType sets the EngineType field's value.

func (*Configuration) SetEngineVersion 

func (s *Configuration) SetEngineVersion(v string) *Configuration

SetEngineVersion sets the EngineVersion field's value.

func (*Configuration) SetId 

func (s *Configuration) SetId(v string) *Configuration

SetId sets the Id field's value.

func (*Configuration) SetLatestRevision 

func (s *Configuration) SetLatestRevision(v *ConfigurationRevision) *Configuration

SetLatestRevision sets the LatestRevision field's value.

func (*Configuration) SetName 

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

SetName sets the Name field's value.

func (*Configuration) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (Configuration) String 

func (s Configuration) String() string

String returns the string representation.

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

type ConfigurationId 

type ConfigurationId struct {

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

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

A list of information about the configuration.

Does not apply to RabbitMQ brokers.

func (ConfigurationId) GoString 

func (s ConfigurationId) GoString() string

GoString returns the string representation.

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

func (*ConfigurationId) SetId 

func (s *ConfigurationId) SetId(v string) *ConfigurationId

SetId sets the Id field's value.

func (*ConfigurationId) SetRevision 

func (s *ConfigurationId) SetRevision(v int64) *ConfigurationId

SetRevision sets the Revision field's value.

func (ConfigurationId) String 

func (s ConfigurationId) String() string

String returns the string representation.

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

func (*ConfigurationId) Validate added in v1.39.2 

func (s *ConfigurationId) Validate() error

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

type ConfigurationRevision 

type ConfigurationRevision struct {

	// Required. The date and time of the configuration revision.
	//
	// Created is a required field
	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601" required:"true"`

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

	// Required. The revision number of the configuration.
	//
	// Revision is a required field
	Revision *int64 `locationName:"revision" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Returns information about the specified configuration revision.

func (ConfigurationRevision) GoString 

func (s ConfigurationRevision) GoString() string

GoString returns the string representation.

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

func (*ConfigurationRevision) SetCreated added in v1.15.1 

func (s *ConfigurationRevision) SetCreated(v time.Time) *ConfigurationRevision

SetCreated sets the Created field's value.

func (*ConfigurationRevision) SetDescription 

func (s *ConfigurationRevision) SetDescription(v string) *ConfigurationRevision

SetDescription sets the Description field's value.

func (*ConfigurationRevision) SetRevision 

func (s *ConfigurationRevision) SetRevision(v int64) *ConfigurationRevision

SetRevision sets the Revision field's value.

func (ConfigurationRevision) String 

func (s ConfigurationRevision) String() string

String returns the string representation.

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

type Configurations 

type Configurations struct {

	// The broker's current configuration.
	Current *ConfigurationId `locationName:"current" type:"structure"`

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

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

Broker configuration information

func (Configurations) GoString 

func (s Configurations) GoString() string

GoString returns the string representation.

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

func (*Configurations) SetCurrent 

func (s *Configurations) SetCurrent(v *ConfigurationId) *Configurations

SetCurrent sets the Current field's value.

func (*Configurations) SetHistory 

func (s *Configurations) SetHistory(v []*ConfigurationId) *Configurations

SetHistory sets the History field's value.

func (*Configurations) SetPending 

func (s *Configurations) SetPending(v *ConfigurationId) *Configurations

SetPending sets the Pending field's value.

func (Configurations) String 

func (s Configurations) String() string

String returns the string representation.

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

type ConflictException added in v1.28.0 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorAttribute *string `locationName:"errorAttribute" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ConflictException) Code added in v1.28.0 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.28.0 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.28.0 

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message added in v1.28.0 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.28.0 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String added in v1.28.0 

func (s ConflictException) String() string

String returns the string representation.

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

type CreateBrokerRequest 

type CreateBrokerRequest struct {

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	// AutoMinorVersionUpgrade is a required field
	AutoMinorVersionUpgrade *bool `locationName:"autoMinorVersionUpgrade" type:"boolean" required:"true"`

	// BrokerName is a required field
	BrokerName *string `locationName:"brokerName" type:"string" required:"true"`

	// A list of information about the configuration.
	//
	// Does not apply to RabbitMQ brokers.
	Configuration *ConfigurationId `locationName:"configuration" type:"structure"`

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

	// The broker's deployment mode.
	//
	// DeploymentMode is a required field
	DeploymentMode *string `locationName:"deploymentMode" type:"string" required:"true" enum:"DeploymentMode"`

	// Does not apply to RabbitMQ brokers.
	//
	// Encryption options for the broker.
	EncryptionOptions *EncryptionOptions `locationName:"encryptionOptions" type:"structure"`

	// The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
	//
	// EngineType is a required field
	EngineType *string `locationName:"engineType" type:"string" required:"true" enum:"EngineType"`

	// EngineVersion is a required field
	EngineVersion *string `locationName:"engineVersion" type:"string" required:"true"`

	// HostInstanceType is a required field
	HostInstanceType *string `locationName:"hostInstanceType" type:"string" required:"true"`

	// Optional. The metadata of the LDAP server used to authenticate and authorize
	// connections to the broker.
	//
	// Does not apply to RabbitMQ brokers.
	LdapServerMetadata *LdapServerMetadataInput `locationName:"ldapServerMetadata" type:"structure"`

	// The list of information about logs to be enabled for the specified broker.
	Logs *Logs `locationName:"logs" type:"structure"`

	// 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 is a required field
	PubliclyAccessible *bool `locationName:"publiclyAccessible" type:"boolean" required:"true"`

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

	// The broker's storage type.
	//
	// EFS is not supported for RabbitMQ engine type.
	StorageType *string `locationName:"storageType" type:"string" enum:"BrokerStorageType"`

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

	Tags map[string]*string `locationName:"tags" type:"map"`

	// Users is a required field
	Users []*User `locationName:"users" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBrokerRequest) GoString 

func (s CreateBrokerRequest) GoString() string

GoString returns the string representation.

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

func (*CreateBrokerRequest) SetAuthenticationStrategy added in v1.33.12 

func (s *CreateBrokerRequest) SetAuthenticationStrategy(v string) *CreateBrokerRequest

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*CreateBrokerRequest) SetAutoMinorVersionUpgrade 

func (s *CreateBrokerRequest) SetAutoMinorVersionUpgrade(v bool) *CreateBrokerRequest

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateBrokerRequest) SetBrokerName 

func (s *CreateBrokerRequest) SetBrokerName(v string) *CreateBrokerRequest

SetBrokerName sets the BrokerName field's value.

func (*CreateBrokerRequest) SetConfiguration 

func (s *CreateBrokerRequest) SetConfiguration(v *ConfigurationId) *CreateBrokerRequest

SetConfiguration sets the Configuration field's value.

func (*CreateBrokerRequest) SetCreatorRequestId 

func (s *CreateBrokerRequest) SetCreatorRequestId(v string) *CreateBrokerRequest

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreateBrokerRequest) SetDeploymentMode 

func (s *CreateBrokerRequest) SetDeploymentMode(v string) *CreateBrokerRequest

SetDeploymentMode sets the DeploymentMode field's value.

func (*CreateBrokerRequest) SetEncryptionOptions added in v1.21.2 

func (s *CreateBrokerRequest) SetEncryptionOptions(v *EncryptionOptions) *CreateBrokerRequest

SetEncryptionOptions sets the EncryptionOptions field's value.

func (*CreateBrokerRequest) SetEngineType 

func (s *CreateBrokerRequest) SetEngineType(v string) *CreateBrokerRequest

SetEngineType sets the EngineType field's value.

func (*CreateBrokerRequest) SetEngineVersion 

func (s *CreateBrokerRequest) SetEngineVersion(v string) *CreateBrokerRequest

SetEngineVersion sets the EngineVersion field's value.

func (*CreateBrokerRequest) SetHostInstanceType 

func (s *CreateBrokerRequest) SetHostInstanceType(v string) *CreateBrokerRequest

SetHostInstanceType sets the HostInstanceType field's value.

func (*CreateBrokerRequest) SetLdapServerMetadata added in v1.33.12 

func (s *CreateBrokerRequest) SetLdapServerMetadata(v *LdapServerMetadataInput) *CreateBrokerRequest

SetLdapServerMetadata sets the LdapServerMetadata field's value.

func (*CreateBrokerRequest) SetLogs added in v1.15.1 

func (s *CreateBrokerRequest) SetLogs(v *Logs) *CreateBrokerRequest

SetLogs sets the Logs field's value.

func (*CreateBrokerRequest) SetMaintenanceWindowStartTime 

func (s *CreateBrokerRequest) SetMaintenanceWindowStartTime(v *WeeklyStartTime) *CreateBrokerRequest

SetMaintenanceWindowStartTime sets the MaintenanceWindowStartTime field's value.

func (*CreateBrokerRequest) SetPubliclyAccessible 

func (s *CreateBrokerRequest) SetPubliclyAccessible(v bool) *CreateBrokerRequest

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*CreateBrokerRequest) SetSecurityGroups 

func (s *CreateBrokerRequest) SetSecurityGroups(v []*string) *CreateBrokerRequest

SetSecurityGroups sets the SecurityGroups field's value.

func (*CreateBrokerRequest) SetStorageType added in v1.26.3 

func (s *CreateBrokerRequest) SetStorageType(v string) *CreateBrokerRequest

SetStorageType sets the StorageType field's value.

func (*CreateBrokerRequest) SetSubnetIds 

func (s *CreateBrokerRequest) SetSubnetIds(v []*string) *CreateBrokerRequest

SetSubnetIds sets the SubnetIds field's value.

func (*CreateBrokerRequest) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (*CreateBrokerRequest) SetUsers 

func (s *CreateBrokerRequest) SetUsers(v []*User) *CreateBrokerRequest

SetUsers sets the Users field's value.

func (CreateBrokerRequest) String 

func (s CreateBrokerRequest) String() string

String returns the string representation.

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

func (*CreateBrokerRequest) Validate added in v1.21.2 

func (s *CreateBrokerRequest) Validate() error

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

type CreateBrokerResponse 

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

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

func (CreateBrokerResponse) GoString 

func (s CreateBrokerResponse) GoString() string

GoString returns the string representation.

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

func (*CreateBrokerResponse) SetBrokerArn 

func (s *CreateBrokerResponse) SetBrokerArn(v string) *CreateBrokerResponse

SetBrokerArn sets the BrokerArn field's value.

func (*CreateBrokerResponse) SetBrokerId 

func (s *CreateBrokerResponse) SetBrokerId(v string) *CreateBrokerResponse

SetBrokerId sets the BrokerId field's value.

func (CreateBrokerResponse) String 

func (s CreateBrokerResponse) String() string

String returns the string representation.

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

type CreateConfigurationRequest 

type CreateConfigurationRequest struct {

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	// The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
	//
	// EngineType is a required field
	EngineType *string `locationName:"engineType" type:"string" required:"true" enum:"EngineType"`

	// EngineVersion is a required field
	EngineVersion *string `locationName:"engineVersion" type:"string" required:"true"`

	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateConfigurationRequest) GoString 

func (s CreateConfigurationRequest) GoString() string

GoString returns the string representation.

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

func (*CreateConfigurationRequest) SetAuthenticationStrategy added in v1.33.12 

func (s *CreateConfigurationRequest) SetAuthenticationStrategy(v string) *CreateConfigurationRequest

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*CreateConfigurationRequest) SetEngineType 

func (s *CreateConfigurationRequest) SetEngineType(v string) *CreateConfigurationRequest

SetEngineType sets the EngineType field's value.

func (*CreateConfigurationRequest) SetEngineVersion 

func (s *CreateConfigurationRequest) SetEngineVersion(v string) *CreateConfigurationRequest

SetEngineVersion sets the EngineVersion field's value.

func (*CreateConfigurationRequest) SetName 

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

SetName sets the Name field's value.

func (*CreateConfigurationRequest) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (CreateConfigurationRequest) String 

func (s CreateConfigurationRequest) String() string

String returns the string representation.

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

func (*CreateConfigurationRequest) Validate added in v1.39.2 

func (s *CreateConfigurationRequest) Validate() error

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

type CreateConfigurationResponse 

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

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601"`

	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
}

func (CreateConfigurationResponse) GoString 

func (s CreateConfigurationResponse) GoString() string

GoString returns the string representation.

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

func (*CreateConfigurationResponse) SetArn 

func (s *CreateConfigurationResponse) SetArn(v string) *CreateConfigurationResponse

SetArn sets the Arn field's value.

func (*CreateConfigurationResponse) SetAuthenticationStrategy added in v1.33.12 

func (s *CreateConfigurationResponse) SetAuthenticationStrategy(v string) *CreateConfigurationResponse

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*CreateConfigurationResponse) SetCreated added in v1.15.1 

func (s *CreateConfigurationResponse) SetCreated(v time.Time) *CreateConfigurationResponse

SetCreated sets the Created field's value.

func (*CreateConfigurationResponse) SetId 

func (s *CreateConfigurationResponse) SetId(v string) *CreateConfigurationResponse

SetId sets the Id field's value.

func (*CreateConfigurationResponse) SetLatestRevision 

func (s *CreateConfigurationResponse) SetLatestRevision(v *ConfigurationRevision) *CreateConfigurationResponse

SetLatestRevision sets the LatestRevision field's value.

func (*CreateConfigurationResponse) SetName 

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

SetName sets the Name field's value.

func (CreateConfigurationResponse) String 

func (s CreateConfigurationResponse) String() string

String returns the string representation.

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

type CreateTagsInput added in v1.16.0 

type CreateTagsInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateTagsInput) GoString added in v1.16.0 

func (s CreateTagsInput) GoString() string

GoString returns the string representation.

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

func (*CreateTagsInput) SetResourceArn added in v1.16.0 

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

SetResourceArn sets the ResourceArn field's value.

func (*CreateTagsInput) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (CreateTagsInput) String added in v1.16.0 

func (s CreateTagsInput) String() string

String returns the string representation.

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

func (*CreateTagsInput) Validate added in v1.16.0 

func (s *CreateTagsInput) Validate() error

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

type CreateTagsOutput added in v1.16.0 

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

func (CreateTagsOutput) GoString added in v1.16.0 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation.

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

func (CreateTagsOutput) String added in v1.16.0 

func (s CreateTagsOutput) String() string

String returns the string representation.

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

type CreateUserOutput 

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

func (CreateUserOutput) GoString 

func (s CreateUserOutput) GoString() string

GoString returns the string representation.

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

func (CreateUserOutput) String 

func (s CreateUserOutput) String() string

String returns the string representation.

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

type CreateUserRequest 

type CreateUserRequest 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 is a required field
	Password *string `locationName:"password" type:"string" required:"true"`

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

func (CreateUserRequest) GoString 

func (s CreateUserRequest) GoString() string

GoString returns the string representation.

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

func (*CreateUserRequest) SetBrokerId 

func (s *CreateUserRequest) SetBrokerId(v string) *CreateUserRequest

SetBrokerId sets the BrokerId field's value.

func (*CreateUserRequest) SetConsoleAccess 

func (s *CreateUserRequest) SetConsoleAccess(v bool) *CreateUserRequest

SetConsoleAccess sets the ConsoleAccess field's value.

func (*CreateUserRequest) SetGroups 

func (s *CreateUserRequest) SetGroups(v []*string) *CreateUserRequest

SetGroups sets the Groups field's value.

func (*CreateUserRequest) SetPassword 

func (s *CreateUserRequest) SetPassword(v string) *CreateUserRequest

SetPassword sets the Password field's value.

func (*CreateUserRequest) SetUsername 

func (s *CreateUserRequest) SetUsername(v string) *CreateUserRequest

SetUsername sets the Username field's value.

func (CreateUserRequest) String 

func (s CreateUserRequest) String() string

String returns the string representation.

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

func (*CreateUserRequest) Validate 

func (s *CreateUserRequest) Validate() error

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

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
}

func (DeleteBrokerInput) GoString 

func (s DeleteBrokerInput) GoString() string

GoString returns the string representation.

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

func (*DeleteBrokerInput) SetBrokerId 

func (s *DeleteBrokerInput) SetBrokerId(v string) *DeleteBrokerInput

SetBrokerId sets the BrokerId field's value.

func (DeleteBrokerInput) String 

func (s DeleteBrokerInput) String() string

String returns the string representation.

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

func (*DeleteBrokerInput) Validate 

func (s *DeleteBrokerInput) Validate() error

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

type DeleteBrokerResponse 

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

func (DeleteBrokerResponse) GoString 

func (s DeleteBrokerResponse) GoString() string

GoString returns the string representation.

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

func (*DeleteBrokerResponse) SetBrokerId 

func (s *DeleteBrokerResponse) SetBrokerId(v string) *DeleteBrokerResponse

SetBrokerId sets the BrokerId field's value.

func (DeleteBrokerResponse) String 

func (s DeleteBrokerResponse) String() string

String returns the string representation.

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

type DeleteTagsInput added in v1.16.0 

type DeleteTagsInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTagsInput) GoString added in v1.16.0 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation.

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

func (*DeleteTagsInput) SetResourceArn added in v1.16.0 

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

SetResourceArn sets the ResourceArn field's value.

func (*DeleteTagsInput) SetTagKeys added in v1.16.0 

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

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String added in v1.16.0 

func (s DeleteTagsInput) String() string

String returns the string representation.

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

func (*DeleteTagsInput) Validate added in v1.16.0 

func (s *DeleteTagsInput) Validate() error

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

type DeleteTagsOutput added in v1.16.0 

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

func (DeleteTagsOutput) GoString added in v1.16.0 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation.

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

func (DeleteTagsOutput) String added in v1.16.0 

func (s DeleteTagsOutput) String() string

String returns the string representation.

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

type 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
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation.

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

func (*DeleteUserInput) SetBrokerId 

func (s *DeleteUserInput) SetBrokerId(v string) *DeleteUserInput

SetBrokerId sets the BrokerId field's value.

func (*DeleteUserInput) SetUsername 

func (s *DeleteUserInput) SetUsername(v string) *DeleteUserInput

SetUsername sets the Username field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation.

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

func (*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
}

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation.

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

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation.

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

type DescribeBrokerEngineTypesInput added in v1.19.12 

type DescribeBrokerEngineTypesInput struct {
	EngineType *string `location:"querystring" locationName:"engineType" type:"string"`

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

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

func (DescribeBrokerEngineTypesInput) GoString added in v1.19.12 

func (s DescribeBrokerEngineTypesInput) GoString() string

GoString returns the string representation.

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

func (*DescribeBrokerEngineTypesInput) SetEngineType added in v1.19.12 

func (s *DescribeBrokerEngineTypesInput) SetEngineType(v string) *DescribeBrokerEngineTypesInput

SetEngineType sets the EngineType field's value.

func (*DescribeBrokerEngineTypesInput) SetMaxResults added in v1.19.12 

func (s *DescribeBrokerEngineTypesInput) SetMaxResults(v int64) *DescribeBrokerEngineTypesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBrokerEngineTypesInput) SetNextToken added in v1.19.12 

func (s *DescribeBrokerEngineTypesInput) SetNextToken(v string) *DescribeBrokerEngineTypesInput

SetNextToken sets the NextToken field's value.

func (DescribeBrokerEngineTypesInput) String added in v1.19.12 

func (s DescribeBrokerEngineTypesInput) String() string

String returns the string representation.

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

func (*DescribeBrokerEngineTypesInput) Validate added in v1.19.12 

func (s *DescribeBrokerEngineTypesInput) Validate() error

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

type DescribeBrokerEngineTypesOutput added in v1.19.12 

type DescribeBrokerEngineTypesOutput struct {
	BrokerEngineTypes []*BrokerEngineType `locationName:"brokerEngineTypes" type:"list"`

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

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

func (DescribeBrokerEngineTypesOutput) GoString added in v1.19.12 

func (s DescribeBrokerEngineTypesOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeBrokerEngineTypesOutput) SetBrokerEngineTypes added in v1.19.12 

func (s *DescribeBrokerEngineTypesOutput) SetBrokerEngineTypes(v []*BrokerEngineType) *DescribeBrokerEngineTypesOutput

SetBrokerEngineTypes sets the BrokerEngineTypes field's value.

func (*DescribeBrokerEngineTypesOutput) SetMaxResults added in v1.19.12 

func (s *DescribeBrokerEngineTypesOutput) SetMaxResults(v int64) *DescribeBrokerEngineTypesOutput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBrokerEngineTypesOutput) SetNextToken added in v1.19.12 

func (s *DescribeBrokerEngineTypesOutput) SetNextToken(v string) *DescribeBrokerEngineTypesOutput

SetNextToken sets the NextToken field's value.

func (DescribeBrokerEngineTypesOutput) String added in v1.19.12 

func (s DescribeBrokerEngineTypesOutput) String() string

String returns the string representation.

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

type 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
}

func (DescribeBrokerInput) GoString 

func (s DescribeBrokerInput) GoString() string

GoString returns the string representation.

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

func (*DescribeBrokerInput) SetBrokerId 

func (s *DescribeBrokerInput) SetBrokerId(v string) *DescribeBrokerInput

SetBrokerId sets the BrokerId field's value.

func (DescribeBrokerInput) String 

func (s DescribeBrokerInput) String() string

String returns the string representation.

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

func (*DescribeBrokerInput) Validate 

func (s *DescribeBrokerInput) Validate() error

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

type DescribeBrokerInstanceOptionsInput added in v1.19.12 

type DescribeBrokerInstanceOptionsInput struct {
	EngineType *string `location:"querystring" locationName:"engineType" type:"string"`

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

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

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

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

func (DescribeBrokerInstanceOptionsInput) GoString added in v1.19.12 

func (s DescribeBrokerInstanceOptionsInput) GoString() string

GoString returns the string representation.

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

func (*DescribeBrokerInstanceOptionsInput) SetEngineType added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsInput) SetEngineType(v string) *DescribeBrokerInstanceOptionsInput

SetEngineType sets the EngineType field's value.

func (*DescribeBrokerInstanceOptionsInput) SetHostInstanceType added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsInput) SetHostInstanceType(v string) *DescribeBrokerInstanceOptionsInput

SetHostInstanceType sets the HostInstanceType field's value.

func (*DescribeBrokerInstanceOptionsInput) SetMaxResults added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsInput) SetMaxResults(v int64) *DescribeBrokerInstanceOptionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBrokerInstanceOptionsInput) SetNextToken added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsInput) SetNextToken(v string) *DescribeBrokerInstanceOptionsInput

SetNextToken sets the NextToken field's value.

func (*DescribeBrokerInstanceOptionsInput) SetStorageType added in v1.26.3 

func (s *DescribeBrokerInstanceOptionsInput) SetStorageType(v string) *DescribeBrokerInstanceOptionsInput

SetStorageType sets the StorageType field's value.

func (DescribeBrokerInstanceOptionsInput) String added in v1.19.12 

func (s DescribeBrokerInstanceOptionsInput) String() string

String returns the string representation.

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

func (*DescribeBrokerInstanceOptionsInput) Validate added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsInput) Validate() error

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

type DescribeBrokerInstanceOptionsOutput added in v1.19.12 

type DescribeBrokerInstanceOptionsOutput struct {
	BrokerInstanceOptions []*BrokerInstanceOption `locationName:"brokerInstanceOptions" type:"list"`

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

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

func (DescribeBrokerInstanceOptionsOutput) GoString added in v1.19.12 

func (s DescribeBrokerInstanceOptionsOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeBrokerInstanceOptionsOutput) SetBrokerInstanceOptions added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsOutput) SetBrokerInstanceOptions(v []*BrokerInstanceOption) *DescribeBrokerInstanceOptionsOutput

SetBrokerInstanceOptions sets the BrokerInstanceOptions field's value.

func (*DescribeBrokerInstanceOptionsOutput) SetMaxResults added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsOutput) SetMaxResults(v int64) *DescribeBrokerInstanceOptionsOutput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBrokerInstanceOptionsOutput) SetNextToken added in v1.19.12 

func (s *DescribeBrokerInstanceOptionsOutput) SetNextToken(v string) *DescribeBrokerInstanceOptionsOutput

SetNextToken sets the NextToken field's value.

func (DescribeBrokerInstanceOptionsOutput) String added in v1.19.12 

func (s DescribeBrokerInstanceOptionsOutput) String() string

String returns the string representation.

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

type DescribeBrokerResponse 

type DescribeBrokerResponse struct {
	ActionsRequired []*ActionRequired `locationName:"actionsRequired" type:"list"`

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	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 broker's status.
	BrokerState *string `locationName:"brokerState" type:"string" enum:"BrokerState"`

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

	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601"`

	// The broker's deployment mode.
	DeploymentMode *string `locationName:"deploymentMode" type:"string" enum:"DeploymentMode"`

	// Does not apply to RabbitMQ brokers.
	//
	// Encryption options for the broker.
	EncryptionOptions *EncryptionOptions `locationName:"encryptionOptions" type:"structure"`

	// The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
	EngineType *string `locationName:"engineType" type:"string" enum:"EngineType"`

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

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

	// Optional. The metadata of the LDAP server used to authenticate and authorize
	// connections to the broker.
	LdapServerMetadata *LdapServerMetadataOutput `locationName:"ldapServerMetadata" type:"structure"`

	// The list of information about logs currently enabled and pending to be deployed
	// for the specified broker.
	Logs *LogsSummary `locationName:"logs" type:"structure"`

	// 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"`

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	PendingAuthenticationStrategy *string `locationName:"pendingAuthenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	PendingEngineVersion *string `locationName:"pendingEngineVersion" type:"string"`

	PendingHostInstanceType *string `locationName:"pendingHostInstanceType" type:"string"`

	// Optional. The metadata of the LDAP server used to authenticate and authorize
	// connections to the broker.
	PendingLdapServerMetadata *LdapServerMetadataOutput `locationName:"pendingLdapServerMetadata" type:"structure"`

	PendingSecurityGroups []*string `locationName:"pendingSecurityGroups" type:"list"`

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

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

	// The broker's storage type.
	//
	// EFS is not supported for RabbitMQ engine type.
	StorageType *string `locationName:"storageType" type:"string" enum:"BrokerStorageType"`

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

	Tags map[string]*string `locationName:"tags" type:"map"`

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

func (DescribeBrokerResponse) GoString 

func (s DescribeBrokerResponse) GoString() string

GoString returns the string representation.

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

func (*DescribeBrokerResponse) SetActionsRequired added in v1.44.0 

func (s *DescribeBrokerResponse) SetActionsRequired(v []*ActionRequired) *DescribeBrokerResponse

SetActionsRequired sets the ActionsRequired field's value.

func (*DescribeBrokerResponse) SetAuthenticationStrategy added in v1.33.12 

func (s *DescribeBrokerResponse) SetAuthenticationStrategy(v string) *DescribeBrokerResponse

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*DescribeBrokerResponse) SetAutoMinorVersionUpgrade 

func (s *DescribeBrokerResponse) SetAutoMinorVersionUpgrade(v bool) *DescribeBrokerResponse

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*DescribeBrokerResponse) SetBrokerArn 

func (s *DescribeBrokerResponse) SetBrokerArn(v string) *DescribeBrokerResponse

SetBrokerArn sets the BrokerArn field's value.

func (*DescribeBrokerResponse) SetBrokerId 

func (s *DescribeBrokerResponse) SetBrokerId(v string) *DescribeBrokerResponse

SetBrokerId sets the BrokerId field's value.

func (*DescribeBrokerResponse) SetBrokerInstances 

func (s *DescribeBrokerResponse) SetBrokerInstances(v []*BrokerInstance) *DescribeBrokerResponse

SetBrokerInstances sets the BrokerInstances field's value.

func (*DescribeBrokerResponse) SetBrokerName 

func (s *DescribeBrokerResponse) SetBrokerName(v string) *DescribeBrokerResponse

SetBrokerName sets the BrokerName field's value.

func (*DescribeBrokerResponse) SetBrokerState 

func (s *DescribeBrokerResponse) SetBrokerState(v string) *DescribeBrokerResponse

SetBrokerState sets the BrokerState field's value.

func (*DescribeBrokerResponse) SetConfigurations 

func (s *DescribeBrokerResponse) SetConfigurations(v *Configurations) *DescribeBrokerResponse

SetConfigurations sets the Configurations field's value.

func (*DescribeBrokerResponse) SetCreated added in v1.15.1 

func (s *DescribeBrokerResponse) SetCreated(v time.Time) *DescribeBrokerResponse

SetCreated sets the Created field's value.

func (*DescribeBrokerResponse) SetDeploymentMode 

func (s *DescribeBrokerResponse) SetDeploymentMode(v string) *DescribeBrokerResponse

SetDeploymentMode sets the DeploymentMode field's value.

func (*DescribeBrokerResponse) SetEncryptionOptions added in v1.21.2 

func (s *DescribeBrokerResponse) SetEncryptionOptions(v *EncryptionOptions) *DescribeBrokerResponse

SetEncryptionOptions sets the EncryptionOptions field's value.

func (*DescribeBrokerResponse) SetEngineType 

func (s *DescribeBrokerResponse) SetEngineType(v string) *DescribeBrokerResponse

SetEngineType sets the EngineType field's value.

func (*DescribeBrokerResponse) SetEngineVersion 

func (s *DescribeBrokerResponse) SetEngineVersion(v string) *DescribeBrokerResponse

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeBrokerResponse) SetHostInstanceType 

func (s *DescribeBrokerResponse) SetHostInstanceType(v string) *DescribeBrokerResponse

SetHostInstanceType sets the HostInstanceType field's value.

func (*DescribeBrokerResponse) SetLdapServerMetadata added in v1.33.12 

func (s *DescribeBrokerResponse) SetLdapServerMetadata(v *LdapServerMetadataOutput) *DescribeBrokerResponse

SetLdapServerMetadata sets the LdapServerMetadata field's value.

func (*DescribeBrokerResponse) SetLogs added in v1.15.1 

func (s *DescribeBrokerResponse) SetLogs(v *LogsSummary) *DescribeBrokerResponse

SetLogs sets the Logs field's value.

func (*DescribeBrokerResponse) SetMaintenanceWindowStartTime 

func (s *DescribeBrokerResponse) SetMaintenanceWindowStartTime(v *WeeklyStartTime) *DescribeBrokerResponse

SetMaintenanceWindowStartTime sets the MaintenanceWindowStartTime field's value.

func (*DescribeBrokerResponse) SetPendingAuthenticationStrategy added in v1.33.12 

func (s *DescribeBrokerResponse) SetPendingAuthenticationStrategy(v string) *DescribeBrokerResponse

SetPendingAuthenticationStrategy sets the PendingAuthenticationStrategy field's value.

func (*DescribeBrokerResponse) SetPendingEngineVersion added in v1.15.44 

func (s *DescribeBrokerResponse) SetPendingEngineVersion(v string) *DescribeBrokerResponse

SetPendingEngineVersion sets the PendingEngineVersion field's value.

func (*DescribeBrokerResponse) SetPendingHostInstanceType added in v1.25.2 

func (s *DescribeBrokerResponse) SetPendingHostInstanceType(v string) *DescribeBrokerResponse

SetPendingHostInstanceType sets the PendingHostInstanceType field's value.

func (*DescribeBrokerResponse) SetPendingLdapServerMetadata added in v1.33.12 

func (s *DescribeBrokerResponse) SetPendingLdapServerMetadata(v *LdapServerMetadataOutput) *DescribeBrokerResponse

SetPendingLdapServerMetadata sets the PendingLdapServerMetadata field's value.

func (*DescribeBrokerResponse) SetPendingSecurityGroups added in v1.23.13 

func (s *DescribeBrokerResponse) SetPendingSecurityGroups(v []*string) *DescribeBrokerResponse

SetPendingSecurityGroups sets the PendingSecurityGroups field's value.

func (*DescribeBrokerResponse) SetPubliclyAccessible 

func (s *DescribeBrokerResponse) SetPubliclyAccessible(v bool) *DescribeBrokerResponse

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*DescribeBrokerResponse) SetSecurityGroups 

func (s *DescribeBrokerResponse) SetSecurityGroups(v []*string) *DescribeBrokerResponse

SetSecurityGroups sets the SecurityGroups field's value.

func (*DescribeBrokerResponse) SetStorageType added in v1.26.3 

func (s *DescribeBrokerResponse) SetStorageType(v string) *DescribeBrokerResponse

SetStorageType sets the StorageType field's value.

func (*DescribeBrokerResponse) SetSubnetIds 

func (s *DescribeBrokerResponse) SetSubnetIds(v []*string) *DescribeBrokerResponse

SetSubnetIds sets the SubnetIds field's value.

func (*DescribeBrokerResponse) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (*DescribeBrokerResponse) SetUsers 

func (s *DescribeBrokerResponse) SetUsers(v []*UserSummary) *DescribeBrokerResponse

SetUsers sets the Users field's value.

func (DescribeBrokerResponse) String 

func (s DescribeBrokerResponse) String() string

String returns the string representation.

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

type 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
}

func (DescribeConfigurationInput) GoString 

func (s DescribeConfigurationInput) GoString() string

GoString returns the string representation.

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

func (*DescribeConfigurationInput) SetConfigurationId 

func (s *DescribeConfigurationInput) SetConfigurationId(v string) *DescribeConfigurationInput

SetConfigurationId sets the ConfigurationId field's value.

func (DescribeConfigurationInput) String 

func (s DescribeConfigurationInput) String() string

String returns the string representation.

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

func (*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"`

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601"`

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

	// The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
	EngineType *string `locationName:"engineType" type:"string" enum:"EngineType"`

	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"`

	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (DescribeConfigurationOutput) GoString 

func (s DescribeConfigurationOutput) GoString() string

GoString returns the string representation.

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

func (*DescribeConfigurationOutput) SetArn 

func (s *DescribeConfigurationOutput) SetArn(v string) *DescribeConfigurationOutput

SetArn sets the Arn field's value.

func (*DescribeConfigurationOutput) SetAuthenticationStrategy added in v1.33.12 

func (s *DescribeConfigurationOutput) SetAuthenticationStrategy(v string) *DescribeConfigurationOutput

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*DescribeConfigurationOutput) SetCreated added in v1.15.1 

func (s *DescribeConfigurationOutput) SetCreated(v time.Time) *DescribeConfigurationOutput

SetCreated sets the Created field's value.

func (*DescribeConfigurationOutput) SetDescription 

func (s *DescribeConfigurationOutput) SetDescription(v string) *DescribeConfigurationOutput

SetDescription sets the Description field's value.

func (*DescribeConfigurationOutput) SetEngineType 

func (s *DescribeConfigurationOutput) SetEngineType(v string) *DescribeConfigurationOutput

SetEngineType sets the EngineType field's value.

func (*DescribeConfigurationOutput) SetEngineVersion 

func (s *DescribeConfigurationOutput) SetEngineVersion(v string) *DescribeConfigurationOutput

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeConfigurationOutput) SetId 

func (s *DescribeConfigurationOutput) SetId(v string) *DescribeConfigurationOutput

SetId sets the Id field's value.

func (*DescribeConfigurationOutput) SetLatestRevision 

func (s *DescribeConfigurationOutput) SetLatestRevision(v *ConfigurationRevision) *DescribeConfigurationOutput

SetLatestRevision sets the LatestRevision field's value.

func (*DescribeConfigurationOutput) SetName 

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

SetName sets the Name field's value.

func (*DescribeConfigurationOutput) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (DescribeConfigurationOutput) String 

func (s DescribeConfigurationOutput) String() string

String returns the string representation.

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

type 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
}

func (DescribeConfigurationRevisionInput) GoString 

func (s DescribeConfigurationRevisionInput) GoString() string

GoString returns the string representation.

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

func (*DescribeConfigurationRevisionInput) SetConfigurationId 

func (s *DescribeConfigurationRevisionInput) SetConfigurationId(v string) *DescribeConfigurationRevisionInput

SetConfigurationId sets the ConfigurationId field's value.

func (*DescribeConfigurationRevisionInput) SetConfigurationRevision 

func (s *DescribeConfigurationRevisionInput) SetConfigurationRevision(v string) *DescribeConfigurationRevisionInput

SetConfigurationRevision sets the ConfigurationRevision field's value.

func (DescribeConfigurationRevisionInput) String 

func (s DescribeConfigurationRevisionInput) String() string

String returns the string representation.

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

func (*DescribeConfigurationRevisionInput) Validate 

func (s *DescribeConfigurationRevisionInput) Validate() error

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

type DescribeConfigurationRevisionResponse 

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

	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601"`

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

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

func (DescribeConfigurationRevisionResponse) GoString 

func (s DescribeConfigurationRevisionResponse) GoString() string

GoString returns the string representation.

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

func (*DescribeConfigurationRevisionResponse) SetConfigurationId 

func (s *DescribeConfigurationRevisionResponse) SetConfigurationId(v string) *DescribeConfigurationRevisionResponse

SetConfigurationId sets the ConfigurationId field's value.

func (*DescribeConfigurationRevisionResponse) SetCreated added in v1.15.1 

func (s *DescribeConfigurationRevisionResponse) SetCreated(v time.Time) *DescribeConfigurationRevisionResponse

SetCreated sets the Created field's value.

func (*DescribeConfigurationRevisionResponse) SetData 

func (s *DescribeConfigurationRevisionResponse) SetData(v string) *DescribeConfigurationRevisionResponse

SetData sets the Data field's value.

func (*DescribeConfigurationRevisionResponse) SetDescription 

func (s *DescribeConfigurationRevisionResponse) SetDescription(v string) *DescribeConfigurationRevisionResponse

SetDescription sets the Description field's value.

func (DescribeConfigurationRevisionResponse) String 

func (s DescribeConfigurationRevisionResponse) String() string

String returns the string representation.

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

type 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
}

func (DescribeUserInput) GoString 

func (s DescribeUserInput) GoString() string

GoString returns the string representation.

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

func (*DescribeUserInput) SetBrokerId 

func (s *DescribeUserInput) SetBrokerId(v string) *DescribeUserInput

SetBrokerId sets the BrokerId field's value.

func (*DescribeUserInput) SetUsername 

func (s *DescribeUserInput) SetUsername(v string) *DescribeUserInput

SetUsername sets the Username field's value.

func (DescribeUserInput) String 

func (s DescribeUserInput) String() string

String returns the string representation.

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

func (*DescribeUserInput) Validate 

func (s *DescribeUserInput) Validate() error

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

type DescribeUserResponse 

type DescribeUserResponse 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
}

func (DescribeUserResponse) GoString 

func (s DescribeUserResponse) GoString() string

GoString returns the string representation.

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

func (*DescribeUserResponse) SetBrokerId 

func (s *DescribeUserResponse) SetBrokerId(v string) *DescribeUserResponse

SetBrokerId sets the BrokerId field's value.

func (*DescribeUserResponse) SetConsoleAccess 

func (s *DescribeUserResponse) SetConsoleAccess(v bool) *DescribeUserResponse

SetConsoleAccess sets the ConsoleAccess field's value.

func (*DescribeUserResponse) SetGroups 

func (s *DescribeUserResponse) SetGroups(v []*string) *DescribeUserResponse

SetGroups sets the Groups field's value.

func (*DescribeUserResponse) SetPending 

func (s *DescribeUserResponse) SetPending(v *UserPendingChanges) *DescribeUserResponse

SetPending sets the Pending field's value.

func (*DescribeUserResponse) SetUsername 

func (s *DescribeUserResponse) SetUsername(v string) *DescribeUserResponse

SetUsername sets the Username field's value.

func (DescribeUserResponse) String 

func (s DescribeUserResponse) String() string

String returns the string representation.

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

type EncryptionOptions added in v1.21.2 

type EncryptionOptions struct {

	// The customer master key (CMK) to use for the AWS Key Management Service (KMS).
	// This key is used to encrypt your data at rest. If not provided, Amazon MQ
	// will use a default CMK to encrypt your data.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
	// Set to true by default, if no value is provided, for example, for RabbitMQ
	// brokers.
	//
	// UseAwsOwnedKey is a required field
	UseAwsOwnedKey *bool `locationName:"useAwsOwnedKey" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Does not apply to RabbitMQ brokers.

Encryption options for the broker.

func (EncryptionOptions) GoString added in v1.21.2 

func (s EncryptionOptions) GoString() string

GoString returns the string representation.

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

func (*EncryptionOptions) SetKmsKeyId added in v1.21.2 

func (s *EncryptionOptions) SetKmsKeyId(v string) *EncryptionOptions

SetKmsKeyId sets the KmsKeyId field's value.

func (*EncryptionOptions) SetUseAwsOwnedKey added in v1.21.2 

func (s *EncryptionOptions) SetUseAwsOwnedKey(v bool) *EncryptionOptions

SetUseAwsOwnedKey sets the UseAwsOwnedKey field's value.

func (EncryptionOptions) String added in v1.21.2 

func (s EncryptionOptions) String() string

String returns the string representation.

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

func (*EncryptionOptions) Validate added in v1.21.2 

func (s *EncryptionOptions) Validate() error

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

type EngineVersion added in v1.19.12 

type EngineVersion struct {

	// Id for the version.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Id of the engine version.

func (EngineVersion) GoString added in v1.19.12 

func (s EngineVersion) GoString() string

GoString returns the string representation.

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

func (*EngineVersion) SetName added in v1.19.12 

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

SetName sets the Name field's value.

func (EngineVersion) String added in v1.19.12 

func (s EngineVersion) String() string

String returns the string representation.

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

type ForbiddenException added in v1.28.0 

type ForbiddenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorAttribute *string `locationName:"errorAttribute" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*ForbiddenException) Code added in v1.28.0 

func (s *ForbiddenException) Code() string

Code returns the exception type name.

func (*ForbiddenException) Error added in v1.28.0 

func (s *ForbiddenException) Error() string

func (ForbiddenException) GoString added in v1.28.0 

func (s ForbiddenException) GoString() string

GoString returns the string representation.

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

func (*ForbiddenException) Message added in v1.28.0 

func (s *ForbiddenException) Message() string

Message returns the exception's message.

func (*ForbiddenException) OrigErr added in v1.28.0 

func (s *ForbiddenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ForbiddenException) RequestID added in v1.28.0 

func (s *ForbiddenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ForbiddenException) StatusCode added in v1.28.0 

func (s *ForbiddenException) StatusCode() int

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

func (ForbiddenException) String added in v1.28.0 

func (s ForbiddenException) String() string

String returns the string representation.

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

type InternalServerErrorException added in v1.28.0 

type InternalServerErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorAttribute *string `locationName:"errorAttribute" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*InternalServerErrorException) Code added in v1.28.0 

func (s *InternalServerErrorException) Code() string

Code returns the exception type name.

func (*InternalServerErrorException) Error added in v1.28.0 

func (s *InternalServerErrorException) Error() string

func (InternalServerErrorException) GoString added in v1.28.0 

func (s InternalServerErrorException) GoString() string

GoString returns the string representation.

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

func (*InternalServerErrorException) Message added in v1.28.0 

func (s *InternalServerErrorException) Message() string

Message returns the exception's message.

func (*InternalServerErrorException) OrigErr added in v1.28.0 

func (s *InternalServerErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerErrorException) RequestID added in v1.28.0 

func (s *InternalServerErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerErrorException) StatusCode added in v1.28.0 

func (s *InternalServerErrorException) StatusCode() int

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

func (InternalServerErrorException) String added in v1.28.0 

func (s InternalServerErrorException) String() string

String returns the string representation.

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

type LdapServerMetadataInput added in v1.33.12 

type LdapServerMetadataInput struct {

	// Specifies the location of the LDAP server such as AWS Directory Service for
	// Microsoft Active Directory . Optional failover server.
	//
	// Hosts is a required field
	Hosts []*string `locationName:"hosts" type:"list" required:"true"`

	// The distinguished name of the node in the directory information tree (DIT)
	// to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example,
	// dc=com.
	//
	// RoleBase is a required field
	RoleBase *string `locationName:"roleBase" type:"string" required:"true"`

	// Specifies the LDAP attribute that identifies the group name attribute in
	// the object returned from the group membership query.
	RoleName *string `locationName:"roleName" type:"string"`

	// The LDAP search filter used to find roles within the roleBase. The distinguished
	// name of the user matched by userSearchMatching is substituted into the {0}
	// placeholder in the search filter. The client's username is substituted into
	// the {1} placeholder. For example, if you set this option to (member=uid={1})for
	// the user janedoe, the search filter becomes (member=uid=janedoe) after string
	// substitution. It matches all role entries that have a member attribute equal
	// to uid=janedoe under the subtree selected by the roleBase.
	//
	// RoleSearchMatching is a required field
	RoleSearchMatching *string `locationName:"roleSearchMatching" type:"string" required:"true"`

	// The directory search scope for the role. If set to true, scope is to search
	// the entire subtree.
	RoleSearchSubtree *bool `locationName:"roleSearchSubtree" type:"boolean"`

	// Service account password. A service account is an account in your LDAP server
	// that has access to initiate a connection. For example, cn=admin,dc=corp,
	// dc=example, dc=com.
	//
	// ServiceAccountPassword is a required field
	ServiceAccountPassword *string `locationName:"serviceAccountPassword" type:"string" required:"true"`

	// Service account username. A service account is an account in your LDAP server
	// that has access to initiate a connection. For example, cn=admin,dc=corp,
	// dc=example, dc=com.
	//
	// ServiceAccountUsername is a required field
	ServiceAccountUsername *string `locationName:"serviceAccountUsername" type:"string" required:"true"`

	// Select a particular subtree of the directory information tree (DIT) to search
	// for user entries. The subtree is specified by a DN, which specifies the base
	// node of the subtree. For example, by setting this option to ou=Users,ou=corp,
	// dc=corp, dc=example, dc=com, the search for user entries is restricted to
	// the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
	//
	// UserBase is a required field
	UserBase *string `locationName:"userBase" type:"string" required:"true"`

	// Specifies the name of the LDAP attribute for the user group membership.
	UserRoleName *string `locationName:"userRoleName" type:"string"`

	// The LDAP search filter used to find users within the userBase. The client's
	// username is substituted into the {0} placeholder in the search filter. For
	// example, if this option is set to (uid={0}) and the received username is
	// janedoe, the search filter becomes (uid=janedoe) after string substitution.
	// It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp,
	// dc=example, dc=com.
	//
	// UserSearchMatching is a required field
	UserSearchMatching *string `locationName:"userSearchMatching" type:"string" required:"true"`

	// The directory search scope for the user. If set to true, scope is to search
	// the entire subtree.
	UserSearchSubtree *bool `locationName:"userSearchSubtree" type:"boolean"`
	// contains filtered or unexported fields
}

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

func (LdapServerMetadataInput) GoString added in v1.33.12 

func (s LdapServerMetadataInput) GoString() string

GoString returns the string representation.

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

func (*LdapServerMetadataInput) SetHosts added in v1.33.12 

func (s *LdapServerMetadataInput) SetHosts(v []*string) *LdapServerMetadataInput

SetHosts sets the Hosts field's value.

func (*LdapServerMetadataInput) SetRoleBase added in v1.33.12 

func (s *LdapServerMetadataInput) SetRoleBase(v string) *LdapServerMetadataInput

SetRoleBase sets the RoleBase field's value.

func (*LdapServerMetadataInput) SetRoleName added in v1.33.12 

func (s *LdapServerMetadataInput) SetRoleName(v string) *LdapServerMetadataInput

SetRoleName sets the RoleName field's value.

func (*LdapServerMetadataInput) SetRoleSearchMatching added in v1.33.12 

func (s *LdapServerMetadataInput) SetRoleSearchMatching(v string) *LdapServerMetadataInput

SetRoleSearchMatching sets the RoleSearchMatching field's value.

func (*LdapServerMetadataInput) SetRoleSearchSubtree added in v1.33.12 

func (s *LdapServerMetadataInput) SetRoleSearchSubtree(v bool) *LdapServerMetadataInput

SetRoleSearchSubtree sets the RoleSearchSubtree field's value.

func (*LdapServerMetadataInput) SetServiceAccountPassword added in v1.33.12 

func (s *LdapServerMetadataInput) SetServiceAccountPassword(v string) *LdapServerMetadataInput

SetServiceAccountPassword sets the ServiceAccountPassword field's value.

func (*LdapServerMetadataInput) SetServiceAccountUsername added in v1.33.12 

func (s *LdapServerMetadataInput) SetServiceAccountUsername(v string) *LdapServerMetadataInput

SetServiceAccountUsername sets the ServiceAccountUsername field's value.

func (*LdapServerMetadataInput) SetUserBase added in v1.33.12 

func (s *LdapServerMetadataInput) SetUserBase(v string) *LdapServerMetadataInput

SetUserBase sets the UserBase field's value.

func (*LdapServerMetadataInput) SetUserRoleName added in v1.33.12 

func (s *LdapServerMetadataInput) SetUserRoleName(v string) *LdapServerMetadataInput

SetUserRoleName sets the UserRoleName field's value.

func (*LdapServerMetadataInput) SetUserSearchMatching added in v1.33.12 

func (s *LdapServerMetadataInput) SetUserSearchMatching(v string) *LdapServerMetadataInput

SetUserSearchMatching sets the UserSearchMatching field's value.

func (*LdapServerMetadataInput) SetUserSearchSubtree added in v1.33.12 

func (s *LdapServerMetadataInput) SetUserSearchSubtree(v bool) *LdapServerMetadataInput

SetUserSearchSubtree sets the UserSearchSubtree field's value.

func (LdapServerMetadataInput) String added in v1.33.12 

func (s LdapServerMetadataInput) String() string

String returns the string representation.

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

func (*LdapServerMetadataInput) Validate added in v1.39.2 

func (s *LdapServerMetadataInput) Validate() error

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

type LdapServerMetadataOutput added in v1.33.12 

type LdapServerMetadataOutput struct {

	// Specifies the location of the LDAP server such as AWS Directory Service for
	// Microsoft Active Directory . Optional failover server.
	//
	// Hosts is a required field
	Hosts []*string `locationName:"hosts" type:"list" required:"true"`

	// The distinguished name of the node in the directory information tree (DIT)
	// to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example,
	// dc=com.
	//
	// RoleBase is a required field
	RoleBase *string `locationName:"roleBase" type:"string" required:"true"`

	// Specifies the LDAP attribute that identifies the group name attribute in
	// the object returned from the group membership query.
	RoleName *string `locationName:"roleName" type:"string"`

	// The LDAP search filter used to find roles within the roleBase. The distinguished
	// name of the user matched by userSearchMatching is substituted into the {0}
	// placeholder in the search filter. The client's username is substituted into
	// the {1} placeholder. For example, if you set this option to (member=uid={1})for
	// the user janedoe, the search filter becomes (member=uid=janedoe) after string
	// substitution. It matches all role entries that have a member attribute equal
	// to uid=janedoe under the subtree selected by the roleBase.
	//
	// RoleSearchMatching is a required field
	RoleSearchMatching *string `locationName:"roleSearchMatching" type:"string" required:"true"`

	// The directory search scope for the role. If set to true, scope is to search
	// the entire subtree.
	RoleSearchSubtree *bool `locationName:"roleSearchSubtree" type:"boolean"`

	// Service account username. A service account is an account in your LDAP server
	// that has access to initiate a connection. For example, cn=admin,dc=corp,
	// dc=example, dc=com.
	//
	// ServiceAccountUsername is a required field
	ServiceAccountUsername *string `locationName:"serviceAccountUsername" type:"string" required:"true"`

	// Select a particular subtree of the directory information tree (DIT) to search
	// for user entries. The subtree is specified by a DN, which specifies the base
	// node of the subtree. For example, by setting this option to ou=Users,ou=corp,
	// dc=corp, dc=example, dc=com, the search for user entries is restricted to
	// the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.
	//
	// UserBase is a required field
	UserBase *string `locationName:"userBase" type:"string" required:"true"`

	// Specifies the name of the LDAP attribute for the user group membership.
	UserRoleName *string `locationName:"userRoleName" type:"string"`

	// The LDAP search filter used to find users within the userBase. The client's
	// username is substituted into the {0} placeholder in the search filter. For
	// example, if this option is set to (uid={0}) and the received username is
	// janedoe, the search filter becomes (uid=janedoe) after string substitution.
	// It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp,
	// dc=example, dc=com.
	//
	// UserSearchMatching is a required field
	UserSearchMatching *string `locationName:"userSearchMatching" type:"string" required:"true"`

	// The directory search scope for the user. If set to true, scope is to search
	// the entire subtree.
	UserSearchSubtree *bool `locationName:"userSearchSubtree" type:"boolean"`
	// contains filtered or unexported fields
}

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

func (LdapServerMetadataOutput) GoString added in v1.33.12 

func (s LdapServerMetadataOutput) GoString() string

GoString returns the string representation.

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

func (*LdapServerMetadataOutput) SetHosts added in v1.33.12 

func (s *LdapServerMetadataOutput) SetHosts(v []*string) *LdapServerMetadataOutput

SetHosts sets the Hosts field's value.

func (*LdapServerMetadataOutput) SetRoleBase added in v1.33.12 

func (s *LdapServerMetadataOutput) SetRoleBase(v string) *LdapServerMetadataOutput

SetRoleBase sets the RoleBase field's value.

func (*LdapServerMetadataOutput) SetRoleName added in v1.33.12 

func (s *LdapServerMetadataOutput) SetRoleName(v string) *LdapServerMetadataOutput

SetRoleName sets the RoleName field's value.

func (*LdapServerMetadataOutput) SetRoleSearchMatching added in v1.33.12 

func (s *LdapServerMetadataOutput) SetRoleSearchMatching(v string) *LdapServerMetadataOutput

SetRoleSearchMatching sets the RoleSearchMatching field's value.

func (*LdapServerMetadataOutput) SetRoleSearchSubtree added in v1.33.12 

func (s *LdapServerMetadataOutput) SetRoleSearchSubtree(v bool) *LdapServerMetadataOutput

SetRoleSearchSubtree sets the RoleSearchSubtree field's value.

func (*LdapServerMetadataOutput) SetServiceAccountUsername added in v1.33.12 

func (s *LdapServerMetadataOutput) SetServiceAccountUsername(v string) *LdapServerMetadataOutput

SetServiceAccountUsername sets the ServiceAccountUsername field's value.

func (*LdapServerMetadataOutput) SetUserBase added in v1.33.12 

func (s *LdapServerMetadataOutput) SetUserBase(v string) *LdapServerMetadataOutput

SetUserBase sets the UserBase field's value.

func (*LdapServerMetadataOutput) SetUserRoleName added in v1.33.12 

func (s *LdapServerMetadataOutput) SetUserRoleName(v string) *LdapServerMetadataOutput

SetUserRoleName sets the UserRoleName field's value.

func (*LdapServerMetadataOutput) SetUserSearchMatching added in v1.33.12 

func (s *LdapServerMetadataOutput) SetUserSearchMatching(v string) *LdapServerMetadataOutput

SetUserSearchMatching sets the UserSearchMatching field's value.

func (*LdapServerMetadataOutput) SetUserSearchSubtree added in v1.33.12 

func (s *LdapServerMetadataOutput) SetUserSearchSubtree(v bool) *LdapServerMetadataOutput

SetUserSearchSubtree sets the UserSearchSubtree field's value.

func (LdapServerMetadataOutput) String added in v1.33.12 

func (s LdapServerMetadataOutput) String() string

String returns the string representation.

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

type 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
}

func (ListBrokersInput) GoString 

func (s ListBrokersInput) GoString() string

GoString returns the string representation.

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

func (*ListBrokersInput) SetMaxResults 

func (s *ListBrokersInput) SetMaxResults(v int64) *ListBrokersInput

SetMaxResults sets the MaxResults field's value.

func (*ListBrokersInput) SetNextToken 

func (s *ListBrokersInput) SetNextToken(v string) *ListBrokersInput

SetNextToken sets the NextToken field's value.

func (ListBrokersInput) String 

func (s ListBrokersInput) String() string

String returns the string representation.

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

func (*ListBrokersInput) Validate 

func (s *ListBrokersInput) Validate() error

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

type ListBrokersResponse 

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

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

func (ListBrokersResponse) GoString 

func (s ListBrokersResponse) GoString() string

GoString returns the string representation.

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

func (*ListBrokersResponse) SetBrokerSummaries 

func (s *ListBrokersResponse) SetBrokerSummaries(v []*BrokerSummary) *ListBrokersResponse

SetBrokerSummaries sets the BrokerSummaries field's value.

func (*ListBrokersResponse) SetNextToken 

func (s *ListBrokersResponse) SetNextToken(v string) *ListBrokersResponse

SetNextToken sets the NextToken field's value.

func (ListBrokersResponse) String 

func (s ListBrokersResponse) String() string

String returns the string representation.

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

type 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
}

func (ListConfigurationRevisionsInput) GoString 

func (s ListConfigurationRevisionsInput) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationRevisionsInput) SetConfigurationId 

func (s *ListConfigurationRevisionsInput) SetConfigurationId(v string) *ListConfigurationRevisionsInput

SetConfigurationId sets the ConfigurationId field's value.

func (*ListConfigurationRevisionsInput) SetMaxResults 

func (s *ListConfigurationRevisionsInput) SetMaxResults(v int64) *ListConfigurationRevisionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationRevisionsInput) SetNextToken 

func (s *ListConfigurationRevisionsInput) SetNextToken(v string) *ListConfigurationRevisionsInput

SetNextToken sets the NextToken field's value.

func (ListConfigurationRevisionsInput) String 

func (s ListConfigurationRevisionsInput) String() string

String returns the string representation.

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

func (*ListConfigurationRevisionsInput) Validate 

func (s *ListConfigurationRevisionsInput) Validate() error

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

type ListConfigurationRevisionsResponse 

type ListConfigurationRevisionsResponse 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
}

func (ListConfigurationRevisionsResponse) GoString 

func (s ListConfigurationRevisionsResponse) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationRevisionsResponse) SetConfigurationId 

func (s *ListConfigurationRevisionsResponse) SetConfigurationId(v string) *ListConfigurationRevisionsResponse

SetConfigurationId sets the ConfigurationId field's value.

func (*ListConfigurationRevisionsResponse) SetMaxResults 

func (s *ListConfigurationRevisionsResponse) SetMaxResults(v int64) *ListConfigurationRevisionsResponse

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationRevisionsResponse) SetNextToken 

func (s *ListConfigurationRevisionsResponse) SetNextToken(v string) *ListConfigurationRevisionsResponse

SetNextToken sets the NextToken field's value.

func (*ListConfigurationRevisionsResponse) SetRevisions 

func (s *ListConfigurationRevisionsResponse) SetRevisions(v []*ConfigurationRevision) *ListConfigurationRevisionsResponse

SetRevisions sets the Revisions field's value.

func (ListConfigurationRevisionsResponse) String 

func (s ListConfigurationRevisionsResponse) String() string

String returns the string representation.

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

type 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
}

func (ListConfigurationsInput) GoString 

func (s ListConfigurationsInput) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationsInput) SetMaxResults 

func (s *ListConfigurationsInput) SetMaxResults(v int64) *ListConfigurationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationsInput) SetNextToken 

func (s *ListConfigurationsInput) SetNextToken(v string) *ListConfigurationsInput

SetNextToken sets the NextToken field's value.

func (ListConfigurationsInput) String 

func (s ListConfigurationsInput) String() string

String returns the string representation.

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

func (*ListConfigurationsInput) Validate 

func (s *ListConfigurationsInput) Validate() error

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

type ListConfigurationsResponse 

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

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

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

func (ListConfigurationsResponse) GoString 

func (s ListConfigurationsResponse) GoString() string

GoString returns the string representation.

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

func (*ListConfigurationsResponse) SetConfigurations 

func (s *ListConfigurationsResponse) SetConfigurations(v []*Configuration) *ListConfigurationsResponse

SetConfigurations sets the Configurations field's value.

func (*ListConfigurationsResponse) SetMaxResults 

func (s *ListConfigurationsResponse) SetMaxResults(v int64) *ListConfigurationsResponse

SetMaxResults sets the MaxResults field's value.

func (*ListConfigurationsResponse) SetNextToken 

func (s *ListConfigurationsResponse) SetNextToken(v string) *ListConfigurationsResponse

SetNextToken sets the NextToken field's value.

func (ListConfigurationsResponse) String 

func (s ListConfigurationsResponse) String() string

String returns the string representation.

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

type ListTagsInput added in v1.16.0 

type ListTagsInput struct {

	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resource-arn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsInput) GoString added in v1.16.0 

func (s ListTagsInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsInput) SetResourceArn added in v1.16.0 

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsInput) String added in v1.16.0 

func (s ListTagsInput) String() string

String returns the string representation.

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

func (*ListTagsInput) Validate added in v1.16.0 

func (s *ListTagsInput) Validate() error

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

type ListTagsOutput added in v1.16.0 

type ListTagsOutput struct {
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsOutput) GoString added in v1.16.0 

func (s ListTagsOutput) GoString() string

GoString returns the string representation.

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

func (*ListTagsOutput) SetTags added in v1.16.0 

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

SetTags sets the Tags field's value.

func (ListTagsOutput) String added in v1.16.0 

func (s ListTagsOutput) String() string

String returns the string representation.

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

type 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
}

func (ListUsersInput) GoString 

func (s ListUsersInput) GoString() string

GoString returns the string representation.

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

func (*ListUsersInput) SetBrokerId 

func (s *ListUsersInput) SetBrokerId(v string) *ListUsersInput

SetBrokerId sets the BrokerId field's value.

func (*ListUsersInput) SetMaxResults 

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNextToken 

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation.

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

func (*ListUsersInput) Validate 

func (s *ListUsersInput) Validate() error

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

type ListUsersResponse 

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

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

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

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

func (ListUsersResponse) GoString 

func (s ListUsersResponse) GoString() string

GoString returns the string representation.

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

func (*ListUsersResponse) SetBrokerId 

func (s *ListUsersResponse) SetBrokerId(v string) *ListUsersResponse

SetBrokerId sets the BrokerId field's value.

func (*ListUsersResponse) SetMaxResults 

func (s *ListUsersResponse) SetMaxResults(v int64) *ListUsersResponse

SetMaxResults sets the MaxResults field's value.

func (*ListUsersResponse) SetNextToken 

func (s *ListUsersResponse) SetNextToken(v string) *ListUsersResponse

SetNextToken sets the NextToken field's value.

func (*ListUsersResponse) SetUsers 

func (s *ListUsersResponse) SetUsers(v []*UserSummary) *ListUsersResponse

SetUsers sets the Users field's value.

func (ListUsersResponse) String 

func (s ListUsersResponse) String() string

String returns the string representation.

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

type Logs added in v1.15.1 

type Logs struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
	Audit *bool `locationName:"audit" type:"boolean"`

	// Enables general logging.
	General *bool `locationName:"general" type:"boolean"`
	// contains filtered or unexported fields
}

The list of information about logs to be enabled for the specified broker.

func (Logs) GoString added in v1.15.1 

func (s Logs) GoString() string

GoString returns the string representation.

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

func (*Logs) SetAudit added in v1.15.1 

func (s *Logs) SetAudit(v bool) *Logs

SetAudit sets the Audit field's value.

func (*Logs) SetGeneral added in v1.15.1 

func (s *Logs) SetGeneral(v bool) *Logs

SetGeneral sets the General field's value.

func (Logs) String added in v1.15.1 

func (s Logs) String() string

String returns the string representation.

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

type LogsSummary added in v1.15.1 

type LogsSummary struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged.
	Audit *bool `locationName:"audit" type:"boolean"`

	// The location of the CloudWatch Logs log group where audit logs are sent.
	AuditLogGroup *string `locationName:"auditLogGroup" type:"string"`

	// Enables general logging.
	//
	// General is a required field
	General *bool `locationName:"general" type:"boolean" required:"true"`

	// The location of the CloudWatch Logs log group where general logs are sent.
	//
	// GeneralLogGroup is a required field
	GeneralLogGroup *string `locationName:"generalLogGroup" type:"string" required:"true"`

	// The list of information about logs pending to be deployed for the specified
	// broker.
	Pending *PendingLogs `locationName:"pending" type:"structure"`
	// contains filtered or unexported fields
}

The list of information about logs currently enabled and pending to be deployed for the specified broker.

func (LogsSummary) GoString added in v1.15.1 

func (s LogsSummary) GoString() string

GoString returns the string representation.

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

func (*LogsSummary) SetAudit added in v1.15.1 

func (s *LogsSummary) SetAudit(v bool) *LogsSummary

SetAudit sets the Audit field's value.

func (*LogsSummary) SetAuditLogGroup added in v1.15.1 

func (s *LogsSummary) SetAuditLogGroup(v string) *LogsSummary

SetAuditLogGroup sets the AuditLogGroup field's value.

func (*LogsSummary) SetGeneral added in v1.15.1 

func (s *LogsSummary) SetGeneral(v bool) *LogsSummary

SetGeneral sets the General field's value.

func (*LogsSummary) SetGeneralLogGroup added in v1.15.1 

func (s *LogsSummary) SetGeneralLogGroup(v string) *LogsSummary

SetGeneralLogGroup sets the GeneralLogGroup field's value.

func (*LogsSummary) SetPending added in v1.15.1 

func (s *LogsSummary) SetPending(v *PendingLogs) *LogsSummary

SetPending sets the Pending field's value.

func (LogsSummary) String added in v1.15.1 

func (s LogsSummary) String() string

String returns the string representation.

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

type 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.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *MQ

New creates a new instance of the MQ client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a MQ client from just a session.
svc := mq.New(mySession)

// Create a MQ client with additional configuration
svc := mq.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*MQ) CreateBroker 

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

CreateBroker API operation for AmazonMQ.

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

  • ec2:CreateNetworkInterface This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

  • ec2:CreateNetworkInterfacePermission This permission is required to attach the ENI to the broker instance.

  • ec2:DeleteNetworkInterface

  • ec2:DeleteNetworkInterfacePermission

  • ec2:DetachNetworkInterface

  • ec2:DescribeInternetGateways

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeNetworkInterfacePermissions

  • ec2:DescribeRouteTables

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your AWS Credentials (https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user) and Never Modify or Delete the Amazon MQ Elastic Network Interface (https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface) in the Amazon MQ Developer Guide.

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 Types:

  • BadRequestException Returns information about an error.

  • UnauthorizedException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) CreateTags added in v1.16.0 

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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) CreateTagsRequest added in v1.16.0 

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

func (*MQ) CreateTagsWithContext added in v1.16.0 

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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) DeleteTags added in v1.16.0 

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

DeleteTags API operation for AmazonMQ.

Removes 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) DeleteTagsRequest added in v1.16.0 

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

func (*MQ) DeleteTagsWithContext added in v1.16.0 

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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) DescribeBrokerEngineTypes added in v1.19.12 

func (c *MQ) DescribeBrokerEngineTypes(input *DescribeBrokerEngineTypesInput) (*DescribeBrokerEngineTypesOutput, error)

DescribeBrokerEngineTypes API operation for AmazonMQ.

Describe available engine types and versions.

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

Returned Error Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) DescribeBrokerEngineTypesRequest added in v1.19.12 

func (c *MQ) DescribeBrokerEngineTypesRequest(input *DescribeBrokerEngineTypesInput) (req *request.Request, output *DescribeBrokerEngineTypesOutput)

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

func (*MQ) DescribeBrokerEngineTypesWithContext added in v1.19.12 

func (c *MQ) DescribeBrokerEngineTypesWithContext(ctx aws.Context, input *DescribeBrokerEngineTypesInput, opts ...request.Option) (*DescribeBrokerEngineTypesOutput, error)

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

See DescribeBrokerEngineTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MQ) DescribeBrokerInstanceOptions added in v1.19.12 

func (c *MQ) DescribeBrokerInstanceOptions(input *DescribeBrokerInstanceOptionsInput) (*DescribeBrokerInstanceOptionsOutput, error)

DescribeBrokerInstanceOptions API operation for AmazonMQ.

Describe available broker instance options.

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

Returned Error Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) DescribeBrokerInstanceOptionsRequest added in v1.19.12 

func (c *MQ) DescribeBrokerInstanceOptionsRequest(input *DescribeBrokerInstanceOptionsInput) (req *request.Request, output *DescribeBrokerInstanceOptionsOutput)

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

func (*MQ) DescribeBrokerInstanceOptionsWithContext added in v1.19.12 

func (c *MQ) DescribeBrokerInstanceOptionsWithContext(ctx aws.Context, input *DescribeBrokerInstanceOptionsInput, opts ...request.Option) (*DescribeBrokerInstanceOptionsOutput, error)

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

See DescribeBrokerInstanceOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) ListBrokersPages added in v1.33.12 

func (c *MQ) ListBrokersPages(input *ListBrokersInput, fn func(*ListBrokersResponse, bool) bool) error

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

See ListBrokers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListBrokers operation.
pageNum := 0
err := client.ListBrokersPages(params,
    func(page *mq.ListBrokersResponse, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*MQ) ListBrokersPagesWithContext added in v1.33.12 

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

ListBrokersPagesWithContext same as ListBrokersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) ListTags added in v1.16.0 

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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) ListTagsRequest added in v1.16.0 

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

func (*MQ) ListTagsWithContext added in v1.16.0 

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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

func (*MQ) 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 Types:

  • NotFoundException Returns information about an error.

  • BadRequestException Returns information about an error.

  • InternalServerErrorException Returns information about an error.

  • ConflictException Returns information about an error.

  • ForbiddenException Returns information about an error.

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

func (*MQ) 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

func (*MQ) 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.

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorAttribute *string `locationName:"errorAttribute" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

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

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

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

type PendingLogs added in v1.15.1 

type PendingLogs struct {

	// Enables audit logging. Every user management action made using JMX or the
	// ActiveMQ Web Console is logged.
	Audit *bool `locationName:"audit" type:"boolean"`

	// Enables general logging.
	General *bool `locationName:"general" type:"boolean"`
	// contains filtered or unexported fields
}

The list of information about logs to be enabled for the specified broker.

func (PendingLogs) GoString added in v1.15.1 

func (s PendingLogs) GoString() string

GoString returns the string representation.

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

func (*PendingLogs) SetAudit added in v1.15.1 

func (s *PendingLogs) SetAudit(v bool) *PendingLogs

SetAudit sets the Audit field's value.

func (*PendingLogs) SetGeneral added in v1.15.1 

func (s *PendingLogs) SetGeneral(v bool) *PendingLogs

SetGeneral sets the General field's value.

func (PendingLogs) String added in v1.15.1 

func (s PendingLogs) String() string

String returns the string representation.

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

type 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
}

func (RebootBrokerInput) GoString 

func (s RebootBrokerInput) GoString() string

GoString returns the string representation.

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

func (*RebootBrokerInput) SetBrokerId 

func (s *RebootBrokerInput) SetBrokerId(v string) *RebootBrokerInput

SetBrokerId sets the BrokerId field's value.

func (RebootBrokerInput) String 

func (s RebootBrokerInput) String() string

String returns the string representation.

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

func (*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
}

func (RebootBrokerOutput) GoString 

func (s RebootBrokerOutput) GoString() string

GoString returns the string representation.

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

func (RebootBrokerOutput) String 

func (s RebootBrokerOutput) String() string

String returns the string representation.

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

type 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.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"SanitizationWarningReason"`
	// contains filtered or unexported fields
}

Returns information about the XML element or attribute that was sanitized in the configuration.

func (SanitizationWarning) GoString 

func (s SanitizationWarning) GoString() string

GoString returns the string representation.

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

func (*SanitizationWarning) SetAttributeName 

func (s *SanitizationWarning) SetAttributeName(v string) *SanitizationWarning

SetAttributeName sets the AttributeName field's value.

func (*SanitizationWarning) SetElementName 

func (s *SanitizationWarning) SetElementName(v string) *SanitizationWarning

SetElementName sets the ElementName field's value.

func (*SanitizationWarning) SetReason 

func (s *SanitizationWarning) SetReason(v string) *SanitizationWarning

SetReason sets the Reason field's value.

func (SanitizationWarning) String 

func (s SanitizationWarning) String() string

String returns the string representation.

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

type UnauthorizedException added in v1.28.0 

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorAttribute *string `locationName:"errorAttribute" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Returns information about an error.

func (*UnauthorizedException) Code added in v1.28.0 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.28.0 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.28.0 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

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

func (*UnauthorizedException) Message added in v1.28.0 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.28.0 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.28.0 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.28.0 

func (s *UnauthorizedException) StatusCode() int

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

func (UnauthorizedException) String added in v1.28.0 

func (s UnauthorizedException) String() string

String returns the string representation.

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

type UpdateBrokerRequest 

type UpdateBrokerRequest struct {

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	AutoMinorVersionUpgrade *bool `locationName:"autoMinorVersionUpgrade" type:"boolean"`

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

	// A list of information about the configuration.
	//
	// Does not apply to RabbitMQ brokers.
	Configuration *ConfigurationId `locationName:"configuration" type:"structure"`

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

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

	// Optional. The metadata of the LDAP server used to authenticate and authorize
	// connections to the broker.
	//
	// Does not apply to RabbitMQ brokers.
	LdapServerMetadata *LdapServerMetadataInput `locationName:"ldapServerMetadata" type:"structure"`

	// The list of information about logs to be enabled for the specified broker.
	Logs *Logs `locationName:"logs" type:"structure"`

	// 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"`

	SecurityGroups []*string `locationName:"securityGroups" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateBrokerRequest) GoString 

func (s UpdateBrokerRequest) GoString() string

GoString returns the string representation.

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

func (*UpdateBrokerRequest) SetAuthenticationStrategy added in v1.33.12 

func (s *UpdateBrokerRequest) SetAuthenticationStrategy(v string) *UpdateBrokerRequest

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*UpdateBrokerRequest) SetAutoMinorVersionUpgrade added in v1.15.44 

func (s *UpdateBrokerRequest) SetAutoMinorVersionUpgrade(v bool) *UpdateBrokerRequest

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*UpdateBrokerRequest) SetBrokerId 

func (s *UpdateBrokerRequest) SetBrokerId(v string) *UpdateBrokerRequest

SetBrokerId sets the BrokerId field's value.

func (*UpdateBrokerRequest) SetConfiguration 

func (s *UpdateBrokerRequest) SetConfiguration(v *ConfigurationId) *UpdateBrokerRequest

SetConfiguration sets the Configuration field's value.

func (*UpdateBrokerRequest) SetEngineVersion added in v1.15.44 

func (s *UpdateBrokerRequest) SetEngineVersion(v string) *UpdateBrokerRequest

SetEngineVersion sets the EngineVersion field's value.

func (*UpdateBrokerRequest) SetHostInstanceType added in v1.25.2 

func (s *UpdateBrokerRequest) SetHostInstanceType(v string) *UpdateBrokerRequest

SetHostInstanceType sets the HostInstanceType field's value.

func (*UpdateBrokerRequest) SetLdapServerMetadata added in v1.33.12 

func (s *UpdateBrokerRequest) SetLdapServerMetadata(v *LdapServerMetadataInput) *UpdateBrokerRequest

SetLdapServerMetadata sets the LdapServerMetadata field's value.

func (*UpdateBrokerRequest) SetLogs added in v1.15.1 

func (s *UpdateBrokerRequest) SetLogs(v *Logs) *UpdateBrokerRequest

SetLogs sets the Logs field's value.

func (*UpdateBrokerRequest) SetMaintenanceWindowStartTime added in v1.39.2 

func (s *UpdateBrokerRequest) SetMaintenanceWindowStartTime(v *WeeklyStartTime) *UpdateBrokerRequest

SetMaintenanceWindowStartTime sets the MaintenanceWindowStartTime field's value.

func (*UpdateBrokerRequest) SetSecurityGroups added in v1.23.13 

func (s *UpdateBrokerRequest) SetSecurityGroups(v []*string) *UpdateBrokerRequest

SetSecurityGroups sets the SecurityGroups field's value.

func (UpdateBrokerRequest) String 

func (s UpdateBrokerRequest) String() string

String returns the string representation.

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

func (*UpdateBrokerRequest) Validate 

func (s *UpdateBrokerRequest) Validate() error

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

type UpdateBrokerResponse 

type UpdateBrokerResponse struct {

	// Optional. The authentication strategy used to secure the broker. The default
	// is SIMPLE.
	AuthenticationStrategy *string `locationName:"authenticationStrategy" type:"string" enum:"AuthenticationStrategy"`

	AutoMinorVersionUpgrade *bool `locationName:"autoMinorVersionUpgrade" type:"boolean"`

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

	// A list of information about the configuration.
	//
	// Does not apply to RabbitMQ brokers.
	Configuration *ConfigurationId `locationName:"configuration" type:"structure"`

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

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

	// Optional. The metadata of the LDAP server used to authenticate and authorize
	// connections to the broker.
	LdapServerMetadata *LdapServerMetadataOutput `locationName:"ldapServerMetadata" type:"structure"`

	// The list of information about logs to be enabled for the specified broker.
	Logs *Logs `locationName:"logs" type:"structure"`

	// 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"`

	SecurityGroups []*string `locationName:"securityGroups" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateBrokerResponse) GoString 

func (s UpdateBrokerResponse) GoString() string

GoString returns the string representation.

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

func (*UpdateBrokerResponse) SetAuthenticationStrategy added in v1.33.12 

func (s *UpdateBrokerResponse) SetAuthenticationStrategy(v string) *UpdateBrokerResponse

SetAuthenticationStrategy sets the AuthenticationStrategy field's value.

func (*UpdateBrokerResponse) SetAutoMinorVersionUpgrade added in v1.15.44 

func (s *UpdateBrokerResponse) SetAutoMinorVersionUpgrade(v bool) *UpdateBrokerResponse

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*UpdateBrokerResponse) SetBrokerId 

func (s *UpdateBrokerResponse) SetBrokerId(v string) *UpdateBrokerResponse

SetBrokerId sets the BrokerId field's value.

func (*UpdateBrokerResponse) SetConfiguration 

func (s *UpdateBrokerResponse) SetConfiguration(v *ConfigurationId) *UpdateBrokerResponse

SetConfiguration sets the Configuration field's value.

func (*UpdateBrokerResponse) SetEngineVersion added in v1.15.44 

func (s *UpdateBrokerResponse) SetEngineVersion(v string) *UpdateBrokerResponse

SetEngineVersion sets the EngineVersion field's value.

func (*UpdateBrokerResponse) SetHostInstanceType added in v1.25.2 

func (s *UpdateBrokerResponse) SetHostInstanceType(v string) *UpdateBrokerResponse

SetHostInstanceType sets the HostInstanceType field's value.

func (*UpdateBrokerResponse) SetLdapServerMetadata added in v1.33.12 

func (s *UpdateBrokerResponse) SetLdapServerMetadata(v *LdapServerMetadataOutput) *UpdateBrokerResponse

SetLdapServerMetadata sets the LdapServerMetadata field's value.

func (*UpdateBrokerResponse) SetLogs added in v1.15.1 

func (s *UpdateBrokerResponse) SetLogs(v *Logs) *UpdateBrokerResponse

SetLogs sets the Logs field's value.

func (*UpdateBrokerResponse) SetMaintenanceWindowStartTime added in v1.39.2 

func (s *UpdateBrokerResponse) SetMaintenanceWindowStartTime(v *WeeklyStartTime) *UpdateBrokerResponse

SetMaintenanceWindowStartTime sets the MaintenanceWindowStartTime field's value.

func (*UpdateBrokerResponse) SetSecurityGroups added in v1.23.13 

func (s *UpdateBrokerResponse) SetSecurityGroups(v []*string) *UpdateBrokerResponse

SetSecurityGroups sets the SecurityGroups field's value.

func (UpdateBrokerResponse) String 

func (s UpdateBrokerResponse) String() string

String returns the string representation.

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

type UpdateConfigurationRequest 

type UpdateConfigurationRequest struct {

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

	// Data is a required field
	Data *string `locationName:"data" type:"string" required:"true"`

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

func (UpdateConfigurationRequest) GoString 

func (s UpdateConfigurationRequest) GoString() string

GoString returns the string representation.

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

func (*UpdateConfigurationRequest) SetConfigurationId 

func (s *UpdateConfigurationRequest) SetConfigurationId(v string) *UpdateConfigurationRequest

SetConfigurationId sets the ConfigurationId field's value.

func (*UpdateConfigurationRequest) SetData 

func (s *UpdateConfigurationRequest) SetData(v string) *UpdateConfigurationRequest

SetData sets the Data field's value.

func (*UpdateConfigurationRequest) SetDescription 

func (s *UpdateConfigurationRequest) SetDescription(v string) *UpdateConfigurationRequest

SetDescription sets the Description field's value.

func (UpdateConfigurationRequest) String 

func (s UpdateConfigurationRequest) String() string

String returns the string representation.

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

func (*UpdateConfigurationRequest) Validate 

func (s *UpdateConfigurationRequest) Validate() error

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

type UpdateConfigurationResponse 

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

	Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"iso8601"`

	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
}

func (UpdateConfigurationResponse) GoString 

func (s UpdateConfigurationResponse) GoString() string

GoString returns the string representation.

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

func (*UpdateConfigurationResponse) SetArn 

func (s *UpdateConfigurationResponse) SetArn(v string) *UpdateConfigurationResponse

SetArn sets the Arn field's value.

func (*UpdateConfigurationResponse) SetCreated added in v1.15.1 

func (s *UpdateConfigurationResponse) SetCreated(v time.Time) *UpdateConfigurationResponse

SetCreated sets the Created field's value.

func (*UpdateConfigurationResponse) SetId 

func (s *UpdateConfigurationResponse) SetId(v string) *UpdateConfigurationResponse

SetId sets the Id field's value.

func (*UpdateConfigurationResponse) SetLatestRevision 

func (s *UpdateConfigurationResponse) SetLatestRevision(v *ConfigurationRevision) *UpdateConfigurationResponse

SetLatestRevision sets the LatestRevision field's value.

func (*UpdateConfigurationResponse) SetName 

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

SetName sets the Name field's value.

func (*UpdateConfigurationResponse) SetWarnings 

func (s *UpdateConfigurationResponse) SetWarnings(v []*SanitizationWarning) *UpdateConfigurationResponse

SetWarnings sets the Warnings field's value.

func (UpdateConfigurationResponse) String 

func (s UpdateConfigurationResponse) String() string

String returns the string representation.

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

type UpdateUserOutput 

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

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation.

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

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation.

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

type UpdateUserRequest 

type UpdateUserRequest 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
}

func (UpdateUserRequest) GoString 

func (s UpdateUserRequest) GoString() string

GoString returns the string representation.

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

func (*UpdateUserRequest) SetBrokerId 

func (s *UpdateUserRequest) SetBrokerId(v string) *UpdateUserRequest

SetBrokerId sets the BrokerId field's value.

func (*UpdateUserRequest) SetConsoleAccess 

func (s *UpdateUserRequest) SetConsoleAccess(v bool) *UpdateUserRequest

SetConsoleAccess sets the ConsoleAccess field's value.

func (*UpdateUserRequest) SetGroups 

func (s *UpdateUserRequest) SetGroups(v []*string) *UpdateUserRequest

SetGroups sets the Groups field's value.

func (*UpdateUserRequest) SetPassword 

func (s *UpdateUserRequest) SetPassword(v string) *UpdateUserRequest

SetPassword sets the Password field's value.

func (*UpdateUserRequest) SetUsername 

func (s *UpdateUserRequest) SetUsername(v string) *UpdateUserRequest

SetUsername sets the Username field's value.

func (UpdateUserRequest) String 

func (s UpdateUserRequest) String() string

String returns the string representation.

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

func (*UpdateUserRequest) Validate 

func (s *UpdateUserRequest) Validate() error

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

type User 

type User struct {

	// Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not
	// apply to RabbitMQ brokers.
	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. Does not
	// apply to RabbitMQ brokers.
	Groups []*string `locationName:"groups" type:"list"`

	// Required. The password of the user. This value must be at least 12 characters
	// long, must contain at least 4 unique characters, and must not contain commas,
	// colons, or equal signs (,:=).
	//
	// Password is a required field
	Password *string `locationName:"password" type:"string" required:"true"`

	// important>Amazon MQ for ActiveMQ For ActiveMQ brokers, this value can contain
	// only alphanumeric characters, dashes, periods, underscores, and tildes (-
	// . _ ~). This value must be 2-100 characters long./important> Amazon MQ for
	// RabbitMQ
	// For RabbitMQ brokers, this value can contain only alphanumeric characters,
	// dashes, periods, underscores (- . _). This value must not contain a tilde
	// (~) character. Amazon MQ prohibts using guest as a valid usename. This value
	// must be 2-100 characters long.
	//
	// Username is a required field
	Username *string `locationName:"username" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A user associated with the broker. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation.

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

func (*User) SetConsoleAccess 

func (s *User) SetConsoleAccess(v bool) *User

SetConsoleAccess sets the ConsoleAccess field's value.

func (*User) SetGroups 

func (s *User) SetGroups(v []*string) *User

SetGroups sets the Groups field's value.

func (*User) SetPassword 

func (s *User) SetPassword(v string) *User

SetPassword sets the Password field's value.

func (*User) SetUsername 

func (s *User) SetUsername(v string) *User

SetUsername sets the Username field's value.

func (User) String 

func (s User) String() string

String returns the string representation.

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

func (*User) Validate added in v1.39.2 

func (s *User) Validate() error

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

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.
	//
	// PendingChange is a required field
	PendingChange *string `locationName:"pendingChange" type:"string" required:"true" enum:"ChangeType"`
	// contains filtered or unexported fields
}

Returns information about the status of the changes pending for the ActiveMQ user.

func (UserPendingChanges) GoString 

func (s UserPendingChanges) GoString() string

GoString returns the string representation.

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

func (*UserPendingChanges) SetConsoleAccess 

func (s *UserPendingChanges) SetConsoleAccess(v bool) *UserPendingChanges

SetConsoleAccess sets the ConsoleAccess field's value.

func (*UserPendingChanges) SetGroups 

func (s *UserPendingChanges) SetGroups(v []*string) *UserPendingChanges

SetGroups sets the Groups field's value.

func (*UserPendingChanges) SetPendingChange 

func (s *UserPendingChanges) SetPendingChange(v string) *UserPendingChanges

SetPendingChange sets the PendingChange field's value.

func (UserPendingChanges) String 

func (s UserPendingChanges) String() string

String returns the string representation.

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

type UserSummary 

type UserSummary struct {

	// The type of change pending for the broker user.
	PendingChange *string `locationName:"pendingChange" type:"string" enum:"ChangeType"`

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

Returns a list of all broker users. Does not apply to RabbitMQ brokers.

func (UserSummary) GoString 

func (s UserSummary) GoString() string

GoString returns the string representation.

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

func (*UserSummary) SetPendingChange 

func (s *UserSummary) SetPendingChange(v string) *UserSummary

SetPendingChange sets the PendingChange field's value.

func (*UserSummary) SetUsername 

func (s *UserSummary) SetUsername(v string) *UserSummary

SetUsername sets the Username field's value.

func (UserSummary) String 

func (s UserSummary) String() string

String returns the string representation.

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

type WeeklyStartTime 

type WeeklyStartTime struct {

	// Required. The day of the week.
	//
	// DayOfWeek is a required field
	DayOfWeek *string `locationName:"dayOfWeek" type:"string" required:"true" enum:"DayOfWeek"`

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

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

func (WeeklyStartTime) GoString 

func (s WeeklyStartTime) GoString() string

GoString returns the string representation.

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

func (*WeeklyStartTime) SetDayOfWeek 

func (s *WeeklyStartTime) SetDayOfWeek(v string) *WeeklyStartTime

SetDayOfWeek sets the DayOfWeek field's value.

func (*WeeklyStartTime) SetTimeOfDay 

func (s *WeeklyStartTime) SetTimeOfDay(v string) *WeeklyStartTime

SetTimeOfDay sets the TimeOfDay field's value.

func (*WeeklyStartTime) SetTimeZone 

func (s *WeeklyStartTime) SetTimeZone(v string) *WeeklyStartTime

SetTimeZone sets the TimeZone field's value.

func (WeeklyStartTime) String 

func (s WeeklyStartTime) String() string

String returns the string representation.

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

func (*WeeklyStartTime) Validate added in v1.39.2 

func (s *WeeklyStartTime) Validate() error

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

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.