libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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
Eq DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

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

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

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 #

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 #

NFData DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

rnf :: DescribeRule -> () #

Hashable DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

hashWithSalt :: Int -> DescribeRule -> Int #

hash :: DescribeRule -> Int #

ToJSON DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

toJSON :: DescribeRule -> Value #

toEncoding :: DescribeRule -> Encoding #

toJSONList :: [DescribeRule] -> Value #

toEncodingList :: [DescribeRule] -> Encoding #

AWSRequest DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Associated Types

type AWSResponse DescribeRule #

Methods

request :: DescribeRule -> Request DescribeRule #

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

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 #

type Rep DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

type Rep DescribeRule = D1 ('MetaData "DescribeRule" "Amazonka.CloudWatchEvents.DescribeRule" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" '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)))
type AWSResponse DescribeRule Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

type AWSResponse DescribeRule = DescribeRuleResponse

newDescribeRule Source #

Arguments

:: Text

$sel:name: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:

$sel:eventBusName: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.

$sel:name: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

  • eventPattern :: Maybe Text

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

  • state :: Maybe RuleState

    Specifies whether the rule is enabled or disabled.

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

  • eventBusName :: Maybe Text

    The name of the event bus associated with the rule.

  • scheduleExpression :: Maybe Text

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

  • name :: Maybe Text

    The name of the rule.

  • description :: Maybe Text

    The description of the rule.

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

  • roleArn :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

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

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

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 #

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 #

NFData DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

Methods

rnf :: DescribeRuleResponse -> () #

type Rep DescribeRuleResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.DescribeRule

type Rep DescribeRuleResponse = D1 ('MetaData "DescribeRuleResponse" "Amazonka.CloudWatchEvents.DescribeRule" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "DescribeRuleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleState))) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "managedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:

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

$sel:state:DescribeRuleResponse', describeRuleResponse_state - Specifies whether the rule is enabled or disabled.

$sel:arn:DescribeRuleResponse', describeRuleResponse_arn - The Amazon Resource Name (ARN) of the rule.

$sel:createdBy: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.

$sel:eventBusName:DescribeRule', describeRuleResponse_eventBusName - The name of the event bus associated with the rule.

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

$sel:name:DescribeRule', describeRuleResponse_name - The name of the rule.

$sel:description:DescribeRuleResponse', describeRuleResponse_description - The description of the rule.

$sel:managedBy: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.

$sel:roleArn:DescribeRuleResponse', describeRuleResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the rule.

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

Response Lenses

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_state :: Lens' DescribeRuleResponse (Maybe RuleState) Source #

Specifies whether the rule is enabled or disabled.

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_eventBusName :: Lens' DescribeRuleResponse (Maybe Text) Source #

The name of the event bus associated with the rule.

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

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

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

The name of the rule.

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

The description of the rule.

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_roleArn :: Lens' DescribeRuleResponse (Maybe Text) Source #

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

describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int Source #

The response's http status code.