Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- mq :: Service
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data BrokerState
- data ChangeType
- data DayOfWeek
- data DeploymentMode
- data EngineType = Activemq
- data SanitizationWarningReason
- data BrokerInstance
- brokerInstance :: BrokerInstance
- biConsoleURL :: Lens' BrokerInstance (Maybe Text)
- biEndpoints :: Lens' BrokerInstance [Text]
- data BrokerSummary
- brokerSummary :: BrokerSummary
- bsBrokerName :: Lens' BrokerSummary (Maybe Text)
- bsBrokerState :: Lens' BrokerSummary (Maybe BrokerState)
- bsDeploymentMode :: Lens' BrokerSummary (Maybe DeploymentMode)
- bsBrokerId :: Lens' BrokerSummary (Maybe Text)
- bsBrokerARN :: Lens' BrokerSummary (Maybe Text)
- bsHostInstanceType :: Lens' BrokerSummary (Maybe Text)
- data Configuration
- configuration :: Configuration
- cEngineVersion :: Lens' Configuration (Maybe Text)
- cARN :: Lens' Configuration (Maybe Text)
- cLatestRevision :: Lens' Configuration (Maybe ConfigurationRevision)
- cName :: Lens' Configuration (Maybe Text)
- cId :: Lens' Configuration (Maybe Text)
- cDescription :: Lens' Configuration (Maybe Text)
- cEngineType :: Lens' Configuration (Maybe EngineType)
- data ConfigurationId
- configurationId :: ConfigurationId
- ciId :: Lens' ConfigurationId (Maybe Text)
- ciRevision :: Lens' ConfigurationId (Maybe Int)
- data ConfigurationRevision
- configurationRevision :: ConfigurationRevision
- crRevision :: Lens' ConfigurationRevision (Maybe Int)
- crDescription :: Lens' ConfigurationRevision (Maybe Text)
- data Configurations
- configurations :: Configurations
- cPending :: Lens' Configurations (Maybe ConfigurationId)
- cHistory :: Lens' Configurations [ConfigurationId]
- cCurrent :: Lens' Configurations (Maybe ConfigurationId)
- data SanitizationWarning
- sanitizationWarning :: SanitizationWarning
- swReason :: Lens' SanitizationWarning (Maybe SanitizationWarningReason)
- swAttributeName :: Lens' SanitizationWarning (Maybe Text)
- swElementName :: Lens' SanitizationWarning (Maybe Text)
- data User
- user :: User
- uGroups :: Lens' User [Text]
- uConsoleAccess :: Lens' User (Maybe Bool)
- uUsername :: Lens' User (Maybe Text)
- uPassword :: Lens' User (Maybe Text)
- data UserPendingChanges
- userPendingChanges :: UserPendingChanges
- upcGroups :: Lens' UserPendingChanges [Text]
- upcConsoleAccess :: Lens' UserPendingChanges (Maybe Bool)
- upcPendingChange :: Lens' UserPendingChanges (Maybe ChangeType)
- data UserSummary
- userSummary :: UserSummary
- usUsername :: Lens' UserSummary (Maybe Text)
- usPendingChange :: Lens' UserSummary (Maybe ChangeType)
- data WeeklyStartTime
- weeklyStartTime :: WeeklyStartTime
- wstTimeOfDay :: Lens' WeeklyStartTime (Maybe Text)
- wstTimeZone :: Lens' WeeklyStartTime (Maybe Text)
- wstDayOfWeek :: Lens' WeeklyStartTime (Maybe DayOfWeek)
Service Configuration
Errors
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Returns information about an error.
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Returns information about an error.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Returns information about an error.
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Returns information about an error.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Returns information about an error.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Returns information about an error.
BrokerState
data BrokerState Source #
The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
ChangeType
data ChangeType Source #
The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE
DayOfWeek
DeploymentMode
data DeploymentMode Source #
The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
EngineType
data EngineType Source #
The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.
SanitizationWarningReason
data SanitizationWarningReason Source #
The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.
BrokerInstance
data BrokerInstance Source #
Returns information about all brokers.
See: brokerInstance
smart constructor.
brokerInstance :: BrokerInstance Source #
Creates a value of BrokerInstance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
biConsoleURL
- The URL of the broker's ActiveMQ Web Console.biEndpoints
- The broker's wire-level protocol endpoints.
biConsoleURL :: Lens' BrokerInstance (Maybe Text) Source #
The URL of the broker's ActiveMQ Web Console.
biEndpoints :: Lens' BrokerInstance [Text] Source #
The broker's wire-level protocol endpoints.
BrokerSummary
data BrokerSummary Source #
The Amazon Resource Name (ARN) of the broker.
See: brokerSummary
smart constructor.
brokerSummary :: BrokerSummary Source #
Creates a value of BrokerSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bsBrokerName
- The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.bsBrokerState
- The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESSbsDeploymentMode
- Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.bsBrokerId
- The unique ID that Amazon MQ generates for the broker.bsBrokerARN
- The Amazon Resource Name (ARN) of the broker.bsHostInstanceType
- The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
bsBrokerName :: Lens' BrokerSummary (Maybe Text) Source #
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
bsBrokerState :: Lens' BrokerSummary (Maybe BrokerState) Source #
The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
bsDeploymentMode :: Lens' BrokerSummary (Maybe DeploymentMode) Source #
Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
bsBrokerId :: Lens' BrokerSummary (Maybe Text) Source #
The unique ID that Amazon MQ generates for the broker.
bsBrokerARN :: Lens' BrokerSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the broker.
bsHostInstanceType :: Lens' BrokerSummary (Maybe Text) Source #
The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
Configuration
data Configuration Source #
Returns information about all configurations.
See: configuration
smart constructor.
configuration :: Configuration Source #
Creates a value of Configuration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cEngineVersion
- Required. The version of the broker engine.cARN
- Required. The ARN of the configuration.cLatestRevision
- Required. The latest revision of the configuration.cName
- 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.cId
- Required. The unique ID that Amazon MQ generates for the configuration.cDescription
- Required. The description of the configuration.cEngineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
cEngineVersion :: Lens' Configuration (Maybe Text) Source #
Required. The version of the broker engine.
cLatestRevision :: Lens' Configuration (Maybe ConfigurationRevision) Source #
Required. The latest revision of the configuration.
cName :: Lens' Configuration (Maybe Text) Source #
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.
cId :: Lens' Configuration (Maybe Text) Source #
Required. The unique ID that Amazon MQ generates for the configuration.
cDescription :: Lens' Configuration (Maybe Text) Source #
Required. The description of the configuration.
cEngineType :: Lens' Configuration (Maybe EngineType) Source #
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
ConfigurationId
data ConfigurationId Source #
A list of information about the configuration.
See: configurationId
smart constructor.
configurationId :: ConfigurationId Source #
Creates a value of ConfigurationId
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ciId
- Required. The unique ID that Amazon MQ generates for the configuration.ciRevision
- The Universally Unique Identifier (UUID) of the request.
ciId :: Lens' ConfigurationId (Maybe Text) Source #
Required. The unique ID that Amazon MQ generates for the configuration.
ciRevision :: Lens' ConfigurationId (Maybe Int) Source #
The Universally Unique Identifier (UUID) of the request.
ConfigurationRevision
data ConfigurationRevision Source #
Returns information about the specified configuration revision.
See: configurationRevision
smart constructor.
configurationRevision :: ConfigurationRevision Source #
Creates a value of ConfigurationRevision
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crRevision
- Required. The revision of the configuration.crDescription
- The description of the configuration revision.
crRevision :: Lens' ConfigurationRevision (Maybe Int) Source #
Required. The revision of the configuration.
crDescription :: Lens' ConfigurationRevision (Maybe Text) Source #
The description of the configuration revision.
Configurations
data Configurations Source #
Broker configuration information
See: configurations
smart constructor.
configurations :: Configurations Source #
Creates a value of Configurations
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cPending :: Lens' Configurations (Maybe ConfigurationId) Source #
The pending configuration of the broker.
cHistory :: Lens' Configurations [ConfigurationId] Source #
The history of configurations applied to the broker.
cCurrent :: Lens' Configurations (Maybe ConfigurationId) Source #
The current configuration of the broker.
SanitizationWarning
data SanitizationWarning Source #
Returns information about the XML element or attribute that was sanitized in the configuration.
See: sanitizationWarning
smart constructor.
sanitizationWarning :: SanitizationWarning Source #
Creates a value of SanitizationWarning
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
swReason
- Required. The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.swAttributeName
- The name of the XML attribute that has been sanitized.swElementName
- The name of the XML element that has been sanitized.
swReason :: Lens' SanitizationWarning (Maybe SanitizationWarningReason) Source #
Required. The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.
swAttributeName :: Lens' SanitizationWarning (Maybe Text) Source #
The name of the XML attribute that has been sanitized.
swElementName :: Lens' SanitizationWarning (Maybe Text) Source #
The name of the XML element that has been sanitized.
User
An ActiveMQ user associated with the broker.
See: user
smart constructor.
Creates a value of User
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uGroups
- 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.uConsoleAccess
- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.uUsername
- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.uPassword
- Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
uGroups :: Lens' User [Text] Source #
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.
uConsoleAccess :: Lens' User (Maybe Bool) Source #
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
uUsername :: Lens' User (Maybe Text) Source #
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
uPassword :: Lens' User (Maybe Text) Source #
Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
UserPendingChanges
data UserPendingChanges Source #
Returns information about the status of the changes pending for the ActiveMQ user.
See: userPendingChanges
smart constructor.
userPendingChanges :: UserPendingChanges Source #
Creates a value of UserPendingChanges
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upcGroups
- 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.upcConsoleAccess
- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.upcPendingChange
- Required. The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE
upcGroups :: Lens' UserPendingChanges [Text] Source #
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.
upcConsoleAccess :: Lens' UserPendingChanges (Maybe Bool) Source #
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
upcPendingChange :: Lens' UserPendingChanges (Maybe ChangeType) Source #
Required. The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE
UserSummary
data UserSummary Source #
Returns a list of all ActiveMQ users.
See: userSummary
smart constructor.
userSummary :: UserSummary Source #
Creates a value of UserSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
usUsername
- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.usPendingChange
- The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE
usUsername :: Lens' UserSummary (Maybe Text) Source #
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
usPendingChange :: Lens' UserSummary (Maybe ChangeType) Source #
The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE
WeeklyStartTime
data WeeklyStartTime Source #
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
See: weeklyStartTime
smart constructor.
weeklyStartTime :: WeeklyStartTime Source #
Creates a value of WeeklyStartTime
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wstTimeOfDay
- Required. The time, in 24-hour format.wstTimeZone
- The time zone, UTC by default, in either the Country/City format, or the UTC offset format.wstDayOfWeek
- Required. The day of the week. Possible values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
wstTimeOfDay :: Lens' WeeklyStartTime (Maybe Text) Source #
Required. The time, in 24-hour format.
wstTimeZone :: Lens' WeeklyStartTime (Maybe Text) Source #
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
wstDayOfWeek :: Lens' WeeklyStartTime (Maybe DayOfWeek) Source #
Required. The day of the week. Possible values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY