Copyright | (c) 2013-2021 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 |
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
- data DescribeRule = DescribeRule' {
- eventBusName :: Maybe Text
- name :: Text
- newDescribeRule :: Text -> DescribeRule
- describeRule_eventBusName :: Lens' DescribeRule (Maybe Text)
- describeRule_name :: Lens' DescribeRule Text
- data DescribeRuleResponse = DescribeRuleResponse' {}
- newDescribeRuleResponse :: Int -> DescribeRuleResponse
- describeRuleResponse_eventPattern :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_state :: Lens' DescribeRuleResponse (Maybe RuleState)
- describeRuleResponse_arn :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_createdBy :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_eventBusName :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_scheduleExpression :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_name :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_description :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_managedBy :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_roleArn :: Lens' DescribeRuleResponse (Maybe Text)
- describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int
Creating a Request
data DescribeRule Source #
See: newDescribeRule
smart constructor.
Constructors
DescribeRule' | |
Fields
|
Instances
Arguments
:: Text | |
-> 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
|
Instances
newDescribeRuleResponse Source #
Arguments
:: Int | |
-> 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.