amazonka-cloudwatch-events-2.0: Amazon EventBridge 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.CloudWatchEvents.DescribeRule

Description

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Synopsis

Creating a Request

data DescribeRule Source #

See: newDescribeRule smart constructor.

Constructors

DescribeRule' 

Fields

  • eventBusName :: Maybe Text

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

  • name :: Text

    The name of the rule.

Instances

Instances details
ToJSON DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

toJSON :: DescribeRule -> Value #

toEncoding :: DescribeRule -> Encoding #

toJSONList :: [DescribeRule] -> Value #

toEncodingList :: [DescribeRule] -> Encoding #

ToHeaders DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

toHeaders :: DescribeRule -> [Header] #

ToPath DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

toPath :: DescribeRule -> ByteString #

ToQuery DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

toQuery :: DescribeRule -> QueryString #

AWSRequest DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Associated Types

type AWSResponse DescribeRule #

Methods

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

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

Generic DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Associated Types

type Rep DescribeRule :: Type -> Type #

Methods

from :: DescribeRule -> Rep DescribeRule x #

to :: Rep DescribeRule x -> DescribeRule #

Read DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

readsPrec :: Int -> ReadS DescribeRule #

readList :: ReadS [DescribeRule] #

readPrec :: ReadPrec DescribeRule #

readListPrec :: ReadPrec [DescribeRule] #

Show DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

showsPrec :: Int -> DescribeRule -> ShowS #

show :: DescribeRule -> String #

showList :: [DescribeRule] -> ShowS #

NFData DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

rnf :: DescribeRule -> () #

Eq DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

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

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

Hashable DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

hashWithSalt :: Int -> DescribeRule -> Int #

hash :: DescribeRule -> Int #

type AWSResponse DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

type AWSResponse DescribeRule = DescribeRuleResponse
type Rep DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

type Rep DescribeRule = D1 ('MetaData "DescribeRule" "Amazonka.CloudWatchEvents.DescribeRule" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRule Source #

Arguments

:: Text

DescribeRule

-> DescribeRule 

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

DescribeRule, describeRule_eventBusName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

DescribeRule, describeRule_name - The name of the rule.

Request Lenses

describeRule_eventBusName :: Lens' DescribeRule (Maybe Text) Source #

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

describeRule_name :: Lens' DescribeRule Text Source #

The name of the rule.

Destructuring the Response

data DescribeRuleResponse Source #

See: newDescribeRuleResponse smart constructor.

Constructors

DescribeRuleResponse' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the rule.

  • createdBy :: Maybe Text

    The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

  • description :: Maybe Text

    The description of the rule.

  • eventBusName :: Maybe Text

    The name of the event bus associated with the rule.

  • eventPattern :: Maybe Text

    The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

  • managedBy :: Maybe Text

    If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

  • name :: Maybe Text

    The name of the rule.

  • roleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the IAM role associated with the rule.

  • scheduleExpression :: Maybe Text

    The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

  • state :: Maybe RuleState

    Specifies whether the rule is enabled or disabled.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Associated Types

type Rep DescribeRuleResponse :: Type -> Type #

Methods

from :: DescribeRuleResponse -> Rep DescribeRuleResponse x #

to :: Rep DescribeRuleResponse x -> DescribeRuleResponse #

Read DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

readsPrec :: Int -> ReadS DescribeRuleResponse #

readList :: ReadS [DescribeRuleResponse] #

readPrec :: ReadPrec DescribeRuleResponse #

readListPrec :: ReadPrec [DescribeRuleResponse] #

Show DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

showsPrec :: Int -> DescribeRuleResponse -> ShowS #

show :: DescribeRuleResponse -> String #

showList :: [DescribeRuleResponse] -> ShowS #

NFData DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

rnf :: DescribeRuleResponse -> () #

Eq DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

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

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

type Rep DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

type Rep DescribeRuleResponse = D1 ('MetaData "DescribeRuleResponse" "Amazonka.CloudWatchEvents.DescribeRule" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "DescribeRuleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "managedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeRuleResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeRuleResponse'

-> DescribeRuleResponse 

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

DescribeRuleResponse, describeRuleResponse_arn - The Amazon Resource Name (ARN) of the rule.

DescribeRuleResponse, describeRuleResponse_createdBy - The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

DescribeRuleResponse, describeRuleResponse_description - The description of the rule.

DescribeRule, describeRuleResponse_eventBusName - The name of the event bus associated with the rule.

DescribeRuleResponse, describeRuleResponse_eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

DescribeRuleResponse, describeRuleResponse_managedBy - If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

DescribeRule, describeRuleResponse_name - The name of the rule.

DescribeRuleResponse, describeRuleResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the rule.

DescribeRuleResponse, describeRuleResponse_scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

DescribeRuleResponse, describeRuleResponse_state - Specifies whether the rule is enabled or disabled.

$sel:httpStatus:DescribeRuleResponse', describeRuleResponse_httpStatus - The response's http status code.

Response Lenses

describeRuleResponse_arn :: Lens' DescribeRuleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

describeRuleResponse_createdBy :: Lens' DescribeRuleResponse (Maybe Text) Source #

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

describeRuleResponse_description :: Lens' DescribeRuleResponse (Maybe Text) Source #

The description of the rule.

describeRuleResponse_eventBusName :: Lens' DescribeRuleResponse (Maybe Text) Source #

The name of the event bus associated with the rule.

describeRuleResponse_eventPattern :: Lens' DescribeRuleResponse (Maybe Text) Source #

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

describeRuleResponse_managedBy :: Lens' DescribeRuleResponse (Maybe Text) Source #

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

describeRuleResponse_name :: Lens' DescribeRuleResponse (Maybe Text) Source #

The name of the rule.

describeRuleResponse_roleArn :: Lens' DescribeRuleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

describeRuleResponse_scheduleExpression :: Lens' DescribeRuleResponse (Maybe Text) Source #

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

describeRuleResponse_state :: Lens' DescribeRuleResponse (Maybe RuleState) Source #

Specifies whether the rule is enabled or disabled.

describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int Source #

The response's http status code.