Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatchEvents.DescribeEventBus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use PutPermission.

For more information about partner event buses, see CreateEventBus.

Creating a Request

data DescribeEventBus Source #

See: newDescribeEventBus smart constructor.

Constructors

DescribeEventBus'
Fields name :: Maybe Text The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

Instances

Instances details

ToJSON DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods toJSON :: DescribeEventBus -> Value # toEncoding :: DescribeEventBus -> Encoding # toJSONList :: [DescribeEventBus] -> Value # toEncodingList :: [DescribeEventBus] -> Encoding #
ToHeaders DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods toHeaders :: DescribeEventBus -> [Header] #
ToPath DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods toPath :: DescribeEventBus -> ByteString #
ToQuery DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods toQuery :: DescribeEventBus -> QueryString #
AWSRequest DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Associated Types type AWSResponse DescribeEventBus # Methods request :: (Service -> Service) -> DescribeEventBus -> Request DescribeEventBus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEventBus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEventBus))) #
Generic DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Associated Types type Rep DescribeEventBus :: Type -> Type # Methods from :: DescribeEventBus -> Rep DescribeEventBus x # to :: Rep DescribeEventBus x -> DescribeEventBus #
Read DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods readsPrec :: Int -> ReadS DescribeEventBus # readList :: ReadS [DescribeEventBus] # readPrec :: ReadPrec DescribeEventBus # readListPrec :: ReadPrec [DescribeEventBus] #
Show DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods showsPrec :: Int -> DescribeEventBus -> ShowS # show :: DescribeEventBus -> String # showList :: [DescribeEventBus] -> ShowS #
NFData DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods rnf :: DescribeEventBus -> () #
Eq DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods (==) :: DescribeEventBus -> DescribeEventBus -> Bool # (/=) :: DescribeEventBus -> DescribeEventBus -> Bool #
Hashable DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods hashWithSalt :: Int -> DescribeEventBus -> Int # hash :: DescribeEventBus -> Int #
type AWSResponse DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus type AWSResponse DescribeEventBus = DescribeEventBusResponse
type Rep DescribeEventBus Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus type Rep DescribeEventBus = D1 ('MetaData "DescribeEventBus" "Amazonka.CloudWatchEvents.DescribeEventBus" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeEventBus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeEventBus :: DescribeEventBus Source #

Create a value of DescribeEventBus 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:

DescribeEventBus, describeEventBus_name - The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

Request Lenses

describeEventBus_name :: Lens' DescribeEventBus (Maybe Text) Source #

The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.

Destructuring the Response

data DescribeEventBusResponse Source #

See: newDescribeEventBusResponse smart constructor.

Constructors

DescribeEventBusResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) of the account permitted to write events to the current account. name :: Maybe Text The name of the event bus. Currently, this is always `default`. policy :: Maybe Text The policy that enables the external account to send events to your account. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeEventBusResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Associated Types type Rep DescribeEventBusResponse :: Type -> Type # Methods from :: DescribeEventBusResponse -> Rep DescribeEventBusResponse x # to :: Rep DescribeEventBusResponse x -> DescribeEventBusResponse #
Read DescribeEventBusResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods readsPrec :: Int -> ReadS DescribeEventBusResponse # readList :: ReadS [DescribeEventBusResponse] # readPrec :: ReadPrec DescribeEventBusResponse # readListPrec :: ReadPrec [DescribeEventBusResponse] #
Show DescribeEventBusResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods showsPrec :: Int -> DescribeEventBusResponse -> ShowS # show :: DescribeEventBusResponse -> String # showList :: [DescribeEventBusResponse] -> ShowS #
NFData DescribeEventBusResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods rnf :: DescribeEventBusResponse -> () #
Eq DescribeEventBusResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus Methods (==) :: DescribeEventBusResponse -> DescribeEventBusResponse -> Bool # (/=) :: DescribeEventBusResponse -> DescribeEventBusResponse -> Bool #
type Rep DescribeEventBusResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.DescribeEventBus type Rep DescribeEventBusResponse = D1 ('MetaData "DescribeEventBusResponse" "Amazonka.CloudWatchEvents.DescribeEventBus" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeEventBusResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventBusResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEventBusResponse'`
-> DescribeEventBusResponse

Create a value of DescribeEventBusResponse 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:

DescribeEventBusResponse, describeEventBusResponse_arn - The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

DescribeEventBus, describeEventBusResponse_name - The name of the event bus. Currently, this is always default.

DescribeEventBusResponse, describeEventBusResponse_policy - The policy that enables the external account to send events to your account.

$sel:httpStatus:DescribeEventBusResponse', describeEventBusResponse_httpStatus - The response's http status code.

Response Lenses

describeEventBusResponse_arn :: Lens' DescribeEventBusResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

describeEventBusResponse_name :: Lens' DescribeEventBusResponse (Maybe Text) Source #

The name of the event bus. Currently, this is always default.

describeEventBusResponse_policy :: Lens' DescribeEventBusResponse (Maybe Text) Source #

The policy that enables the external account to send events to your account.

describeEventBusResponse_httpStatus :: Lens' DescribeEventBusResponse Int Source #

The response's http status code.