amazonka-mq-2.0: Amazon MQ SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MQ.DescribeBroker

Description

Returns information about the specified broker.

Synopsis

Creating a Request

data DescribeBroker Source #

See: newDescribeBroker smart constructor.

Constructors

DescribeBroker' 

Fields

  • brokerId :: Text

    The unique ID that Amazon MQ generates for the broker.

Instances

Instances details
ToHeaders DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

toHeaders :: DescribeBroker -> [Header] #

ToPath DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

toPath :: DescribeBroker -> ByteString #

ToQuery DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

toQuery :: DescribeBroker -> QueryString #

AWSRequest DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Associated Types

type AWSResponse DescribeBroker #

Methods

request :: (Service -> Service) -> DescribeBroker -> Request DescribeBroker #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBroker -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBroker))) #

Generic DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Associated Types

type Rep DescribeBroker :: Type -> Type #

Methods

from :: DescribeBroker -> Rep DescribeBroker x #

to :: Rep DescribeBroker x -> DescribeBroker #

Read DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

readsPrec :: Int -> ReadS DescribeBroker #

readList :: ReadS [DescribeBroker] #

readPrec :: ReadPrec DescribeBroker #

readListPrec :: ReadPrec [DescribeBroker] #

Show DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

showsPrec :: Int -> DescribeBroker -> ShowS #

show :: DescribeBroker -> String #

showList :: [DescribeBroker] -> ShowS #

NFData DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

rnf :: DescribeBroker -> () #

Eq DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

(==) :: DescribeBroker -> DescribeBroker -> Bool #

(/=) :: DescribeBroker -> DescribeBroker -> Bool #

Hashable DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

hashWithSalt :: Int -> DescribeBroker -> Int #

hash :: DescribeBroker -> Int #

type AWSResponse DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

type AWSResponse DescribeBroker = DescribeBrokerResponse
type Rep DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

type Rep DescribeBroker = D1 ('MetaData "DescribeBroker" "Amazonka.MQ.DescribeBroker" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "DescribeBroker'" 'PrefixI 'True) (S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeBroker Source #

Arguments

:: Text

DescribeBroker

-> DescribeBroker 

Create a value of DescribeBroker with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeBroker, describeBroker_brokerId - The unique ID that Amazon MQ generates for the broker.

Request Lenses

describeBroker_brokerId :: Lens' DescribeBroker Text Source #

The unique ID that Amazon MQ generates for the broker.

Destructuring the Response

data DescribeBrokerResponse Source #

See: newDescribeBrokerResponse smart constructor.

Constructors

DescribeBrokerResponse' 

Fields

Instances

Instances details
Generic DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Associated Types

type Rep DescribeBrokerResponse :: Type -> Type #

Methods

from :: DescribeBrokerResponse -> Rep DescribeBrokerResponse x #

to :: Rep DescribeBrokerResponse x -> DescribeBrokerResponse #

Read DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

readsPrec :: Int -> ReadS DescribeBrokerResponse #

readList :: ReadS [DescribeBrokerResponse] #

readPrec :: ReadPrec DescribeBrokerResponse #

readListPrec :: ReadPrec [DescribeBrokerResponse] #

Show DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

showsPrec :: Int -> DescribeBrokerResponse -> ShowS #

show :: DescribeBrokerResponse -> String #

showList :: [DescribeBrokerResponse] -> ShowS #

NFData DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

rnf :: DescribeBrokerResponse -> () #

Eq DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

(==) :: DescribeBrokerResponse -> DescribeBrokerResponse -> Bool #

(/=) :: DescribeBrokerResponse -> DescribeBrokerResponse -> Bool #

type Rep DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

type Rep DescribeBrokerResponse = D1 ('MetaData "DescribeBrokerResponse" "Amazonka.MQ.DescribeBroker" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "DescribeBrokerResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "actionsRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ActionRequired])) :*: (S1 ('MetaSel ('Just "authenticationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationStrategy)) :*: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "brokerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "brokerInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BrokerInstance])) :*: S1 ('MetaSel ('Just "brokerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "brokerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerState)) :*: S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Configurations))) :*: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "deploymentMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentMode)))) :*: ((S1 ('MetaSel ('Just "encryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionOptions)) :*: S1 ('MetaSel ('Just "engineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineType))) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hostInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "ldapServerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LdapServerMetadataOutput)) :*: (S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogsSummary)) :*: S1 ('MetaSel ('Just "maintenanceWindowStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WeeklyStartTime)))) :*: ((S1 ('MetaSel ('Just "pendingAuthenticationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationStrategy)) :*: S1 ('MetaSel ('Just "pendingEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pendingHostInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pendingLdapServerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LdapServerMetadataOutput))))) :*: (((S1 ('MetaSel ('Just "pendingSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerStorageType)))) :*: ((S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeBrokerResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeBrokerResponse'

-> DescribeBrokerResponse 

Create a value of DescribeBrokerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:actionsRequired:DescribeBrokerResponse', describeBrokerResponse_actionsRequired - A list of actions required for a broker.

DescribeBrokerResponse, describeBrokerResponse_authenticationStrategy - The authentication strategy used to secure the broker. The default is SIMPLE.

$sel:autoMinorVersionUpgrade:DescribeBrokerResponse', describeBrokerResponse_autoMinorVersionUpgrade - Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

DescribeBrokerResponse, describeBrokerResponse_brokerArn - The broker's Amazon Resource Name (ARN).

DescribeBroker, describeBrokerResponse_brokerId - The unique ID that Amazon MQ generates for the broker.

$sel:brokerInstances:DescribeBrokerResponse', describeBrokerResponse_brokerInstances - A list of information about allocated brokers.

DescribeBrokerResponse, describeBrokerResponse_brokerName - The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.

DescribeBrokerResponse, describeBrokerResponse_brokerState - The broker's status.

$sel:configurations:DescribeBrokerResponse', describeBrokerResponse_configurations - The list of all revisions for the specified configuration.

DescribeBrokerResponse, describeBrokerResponse_created - The time when the broker was created.

DescribeBrokerResponse, describeBrokerResponse_deploymentMode - The broker's deployment mode.

$sel:encryptionOptions:DescribeBrokerResponse', describeBrokerResponse_encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.

DescribeBrokerResponse, describeBrokerResponse_engineType - The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

DescribeBrokerResponse, describeBrokerResponse_engineVersion - The broker engine's version. For a list of supported engine versions, see Supported engines.

DescribeBrokerResponse, describeBrokerResponse_hostInstanceType - The broker's instance type.

$sel:ldapServerMetadata:DescribeBrokerResponse', describeBrokerResponse_ldapServerMetadata - The metadata of the LDAP server used to authenticate and authorize connections to the broker.

$sel:logs:DescribeBrokerResponse', describeBrokerResponse_logs - The list of information about logs currently enabled and pending to be deployed for the specified broker.

$sel:maintenanceWindowStartTime:DescribeBrokerResponse', describeBrokerResponse_maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

$sel:pendingAuthenticationStrategy:DescribeBrokerResponse', describeBrokerResponse_pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

$sel:pendingEngineVersion:DescribeBrokerResponse', describeBrokerResponse_pendingEngineVersion - The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

$sel:pendingHostInstanceType:DescribeBrokerResponse', describeBrokerResponse_pendingHostInstanceType - The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

$sel:pendingLdapServerMetadata:DescribeBrokerResponse', describeBrokerResponse_pendingLdapServerMetadata - The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

$sel:pendingSecurityGroups:DescribeBrokerResponse', describeBrokerResponse_pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.

$sel:publiclyAccessible:DescribeBrokerResponse', describeBrokerResponse_publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets.

$sel:securityGroups:DescribeBrokerResponse', describeBrokerResponse_securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

DescribeBrokerResponse, describeBrokerResponse_storageType - The broker's storage type.

$sel:subnetIds:DescribeBrokerResponse', describeBrokerResponse_subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

DescribeBrokerResponse, describeBrokerResponse_tags - The list of all tags associated with this broker.

$sel:users:DescribeBrokerResponse', describeBrokerResponse_users - The list of all broker usernames for the specified broker.

$sel:httpStatus:DescribeBrokerResponse', describeBrokerResponse_httpStatus - The response's http status code.

Response Lenses

describeBrokerResponse_actionsRequired :: Lens' DescribeBrokerResponse (Maybe [ActionRequired]) Source #

A list of actions required for a broker.

describeBrokerResponse_authenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #

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

describeBrokerResponse_autoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool) Source #

Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.

describeBrokerResponse_brokerArn :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's Amazon Resource Name (ARN).

describeBrokerResponse_brokerId :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The unique ID that Amazon MQ generates for the broker.

describeBrokerResponse_brokerInstances :: Lens' DescribeBrokerResponse (Maybe [BrokerInstance]) Source #

A list of information about allocated brokers.

describeBrokerResponse_brokerName :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's name. 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 white spaces, brackets, wildcard characters, or special characters.

describeBrokerResponse_brokerState :: Lens' DescribeBrokerResponse (Maybe BrokerState) Source #

The broker's status.

describeBrokerResponse_configurations :: Lens' DescribeBrokerResponse (Maybe Configurations) Source #

The list of all revisions for the specified configuration.

describeBrokerResponse_created :: Lens' DescribeBrokerResponse (Maybe UTCTime) Source #

The time when the broker was created.

describeBrokerResponse_deploymentMode :: Lens' DescribeBrokerResponse (Maybe DeploymentMode) Source #

The broker's deployment mode.

describeBrokerResponse_encryptionOptions :: Lens' DescribeBrokerResponse (Maybe EncryptionOptions) Source #

Encryption options for the broker. Does not apply to RabbitMQ brokers.

describeBrokerResponse_engineType :: Lens' DescribeBrokerResponse (Maybe EngineType) Source #

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

describeBrokerResponse_engineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker engine's version. For a list of supported engine versions, see Supported engines.

describeBrokerResponse_hostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's instance type.

describeBrokerResponse_ldapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #

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

describeBrokerResponse_logs :: Lens' DescribeBrokerResponse (Maybe LogsSummary) Source #

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

describeBrokerResponse_maintenanceWindowStartTime :: Lens' DescribeBrokerResponse (Maybe WeeklyStartTime) Source #

The parameters that determine the WeeklyStartTime.

describeBrokerResponse_pendingAuthenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

describeBrokerResponse_pendingEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

describeBrokerResponse_pendingHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

describeBrokerResponse_pendingLdapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

describeBrokerResponse_pendingSecurityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of pending security groups to authorize connections to brokers.

describeBrokerResponse_publiclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool) Source #

Enables connections from applications outside of the VPC that hosts the broker's subnets.

describeBrokerResponse_securityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

describeBrokerResponse_storageType :: Lens' DescribeBrokerResponse (Maybe BrokerStorageType) Source #

The broker's storage type.

describeBrokerResponse_subnetIds :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

describeBrokerResponse_tags :: Lens' DescribeBrokerResponse (Maybe (HashMap Text Text)) Source #

The list of all tags associated with this broker.

describeBrokerResponse_users :: Lens' DescribeBrokerResponse (Maybe [UserSummary]) Source #

The list of all broker usernames for the specified broker.

describeBrokerResponse_httpStatus :: Lens' DescribeBrokerResponse Int Source #

The response's http status code.