| 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.CodeStarNotifications.Lens
Contents
Description
Synopsis
- createNotificationRule_status :: Lens' CreateNotificationRule (Maybe NotificationRuleStatus)
- createNotificationRule_clientRequestToken :: Lens' CreateNotificationRule (Maybe Text)
- createNotificationRule_tags :: Lens' CreateNotificationRule (Maybe (HashMap Text Text))
- createNotificationRule_name :: Lens' CreateNotificationRule Text
- createNotificationRule_eventTypeIds :: Lens' CreateNotificationRule [Text]
- createNotificationRule_resource :: Lens' CreateNotificationRule Text
- createNotificationRule_targets :: Lens' CreateNotificationRule [Target]
- createNotificationRule_detailType :: Lens' CreateNotificationRule DetailType
- createNotificationRuleResponse_arn :: Lens' CreateNotificationRuleResponse (Maybe Text)
- createNotificationRuleResponse_httpStatus :: Lens' CreateNotificationRuleResponse Int
- updateNotificationRule_status :: Lens' UpdateNotificationRule (Maybe NotificationRuleStatus)
- updateNotificationRule_eventTypeIds :: Lens' UpdateNotificationRule (Maybe [Text])
- updateNotificationRule_detailType :: Lens' UpdateNotificationRule (Maybe DetailType)
- updateNotificationRule_name :: Lens' UpdateNotificationRule (Maybe Text)
- updateNotificationRule_targets :: Lens' UpdateNotificationRule (Maybe [Target])
- updateNotificationRule_arn :: Lens' UpdateNotificationRule Text
- updateNotificationRuleResponse_httpStatus :: Lens' UpdateNotificationRuleResponse Int
- deleteNotificationRule_arn :: Lens' DeleteNotificationRule Text
- deleteNotificationRuleResponse_arn :: Lens' DeleteNotificationRuleResponse (Maybe Text)
- deleteNotificationRuleResponse_httpStatus :: Lens' DeleteNotificationRuleResponse Int
- listTagsForResource_arn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listEventTypes_filters :: Lens' ListEventTypes (Maybe [ListEventTypesFilter])
- listEventTypes_nextToken :: Lens' ListEventTypes (Maybe Text)
- listEventTypes_maxResults :: Lens' ListEventTypes (Maybe Natural)
- listEventTypesResponse_eventTypes :: Lens' ListEventTypesResponse (Maybe [EventTypeSummary])
- listEventTypesResponse_nextToken :: Lens' ListEventTypesResponse (Maybe Text)
- listEventTypesResponse_httpStatus :: Lens' ListEventTypesResponse Int
- deleteTarget_forceUnsubscribeAll :: Lens' DeleteTarget (Maybe Bool)
- deleteTarget_targetAddress :: Lens' DeleteTarget Text
- deleteTargetResponse_httpStatus :: Lens' DeleteTargetResponse Int
- listNotificationRules_filters :: Lens' ListNotificationRules (Maybe [ListNotificationRulesFilter])
- listNotificationRules_nextToken :: Lens' ListNotificationRules (Maybe Text)
- listNotificationRules_maxResults :: Lens' ListNotificationRules (Maybe Natural)
- listNotificationRulesResponse_nextToken :: Lens' ListNotificationRulesResponse (Maybe Text)
- listNotificationRulesResponse_notificationRules :: Lens' ListNotificationRulesResponse (Maybe [NotificationRuleSummary])
- listNotificationRulesResponse_httpStatus :: Lens' ListNotificationRulesResponse Int
- listTargets_filters :: Lens' ListTargets (Maybe [ListTargetsFilter])
- listTargets_nextToken :: Lens' ListTargets (Maybe Text)
- listTargets_maxResults :: Lens' ListTargets (Maybe Natural)
- listTargetsResponse_nextToken :: Lens' ListTargetsResponse (Maybe Text)
- listTargetsResponse_targets :: Lens' ListTargetsResponse (Maybe [TargetSummary])
- listTargetsResponse_httpStatus :: Lens' ListTargetsResponse Int
- tagResource_arn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_tags :: Lens' TagResourceResponse (Maybe (HashMap Text Text))
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- subscribe_clientRequestToken :: Lens' Subscribe (Maybe Text)
- subscribe_arn :: Lens' Subscribe Text
- subscribe_target :: Lens' Subscribe Target
- subscribeResponse_arn :: Lens' SubscribeResponse (Maybe Text)
- subscribeResponse_httpStatus :: Lens' SubscribeResponse Int
- untagResource_arn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- unsubscribe_arn :: Lens' Unsubscribe Text
- unsubscribe_targetAddress :: Lens' Unsubscribe Text
- unsubscribeResponse_httpStatus :: Lens' UnsubscribeResponse Int
- unsubscribeResponse_arn :: Lens' UnsubscribeResponse Text
- describeNotificationRule_arn :: Lens' DescribeNotificationRule Text
- describeNotificationRuleResponse_status :: Lens' DescribeNotificationRuleResponse (Maybe NotificationRuleStatus)
- describeNotificationRuleResponse_eventTypes :: Lens' DescribeNotificationRuleResponse (Maybe [EventTypeSummary])
- describeNotificationRuleResponse_lastModifiedTimestamp :: Lens' DescribeNotificationRuleResponse (Maybe UTCTime)
- describeNotificationRuleResponse_createdBy :: Lens' DescribeNotificationRuleResponse (Maybe Text)
- describeNotificationRuleResponse_detailType :: Lens' DescribeNotificationRuleResponse (Maybe DetailType)
- describeNotificationRuleResponse_name :: Lens' DescribeNotificationRuleResponse (Maybe Text)
- describeNotificationRuleResponse_targets :: Lens' DescribeNotificationRuleResponse (Maybe [TargetSummary])
- describeNotificationRuleResponse_resource :: Lens' DescribeNotificationRuleResponse (Maybe Text)
- describeNotificationRuleResponse_createdTimestamp :: Lens' DescribeNotificationRuleResponse (Maybe UTCTime)
- describeNotificationRuleResponse_tags :: Lens' DescribeNotificationRuleResponse (Maybe (HashMap Text Text))
- describeNotificationRuleResponse_httpStatus :: Lens' DescribeNotificationRuleResponse Int
- describeNotificationRuleResponse_arn :: Lens' DescribeNotificationRuleResponse Text
- eventTypeSummary_resourceType :: Lens' EventTypeSummary (Maybe Text)
- eventTypeSummary_eventTypeName :: Lens' EventTypeSummary (Maybe Text)
- eventTypeSummary_eventTypeId :: Lens' EventTypeSummary (Maybe Text)
- eventTypeSummary_serviceName :: Lens' EventTypeSummary (Maybe Text)
- listEventTypesFilter_name :: Lens' ListEventTypesFilter ListEventTypesFilterName
- listEventTypesFilter_value :: Lens' ListEventTypesFilter Text
- listNotificationRulesFilter_name :: Lens' ListNotificationRulesFilter ListNotificationRulesFilterName
- listNotificationRulesFilter_value :: Lens' ListNotificationRulesFilter Text
- listTargetsFilter_name :: Lens' ListTargetsFilter ListTargetsFilterName
- listTargetsFilter_value :: Lens' ListTargetsFilter Text
- notificationRuleSummary_arn :: Lens' NotificationRuleSummary (Maybe Text)
- notificationRuleSummary_id :: Lens' NotificationRuleSummary (Maybe Text)
- target_targetType :: Lens' Target (Maybe Text)
- target_targetAddress :: Lens' Target (Maybe Text)
- targetSummary_targetType :: Lens' TargetSummary (Maybe Text)
- targetSummary_targetAddress :: Lens' TargetSummary (Maybe Text)
- targetSummary_targetStatus :: Lens' TargetSummary (Maybe TargetStatus)
Operations
CreateNotificationRule
createNotificationRule_status :: Lens' CreateNotificationRule (Maybe NotificationRuleStatus) Source #
The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.
createNotificationRule_clientRequestToken :: Lens' CreateNotificationRule (Maybe Text) Source #
A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.
The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.
createNotificationRule_tags :: Lens' CreateNotificationRule (Maybe (HashMap Text Text)) Source #
A list of tags to apply to this notification rule. Key names cannot start with "aws".
createNotificationRule_name :: Lens' CreateNotificationRule Text Source #
The name for the notification rule. Notifictaion rule names must be unique in your AWS account.
createNotificationRule_eventTypeIds :: Lens' CreateNotificationRule [Text] Source #
A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.
createNotificationRule_resource :: Lens' CreateNotificationRule Text Source #
The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.
createNotificationRule_targets :: Lens' CreateNotificationRule [Target] Source #
A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.
createNotificationRule_detailType :: Lens' CreateNotificationRule DetailType Source #
The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
createNotificationRuleResponse_arn :: Lens' CreateNotificationRuleResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the notification rule.
createNotificationRuleResponse_httpStatus :: Lens' CreateNotificationRuleResponse Int Source #
The response's http status code.
UpdateNotificationRule
updateNotificationRule_status :: Lens' UpdateNotificationRule (Maybe NotificationRuleStatus) Source #
The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).
updateNotificationRule_eventTypeIds :: Lens' UpdateNotificationRule (Maybe [Text]) Source #
A list of event types associated with this notification rule.
updateNotificationRule_detailType :: Lens' UpdateNotificationRule (Maybe DetailType) Source #
The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
updateNotificationRule_name :: Lens' UpdateNotificationRule (Maybe Text) Source #
The name of the notification rule.
updateNotificationRule_targets :: Lens' UpdateNotificationRule (Maybe [Target]) Source #
The address and type of the targets to receive notifications from this notification rule.
updateNotificationRule_arn :: Lens' UpdateNotificationRule Text Source #
The Amazon Resource Name (ARN) of the notification rule.
updateNotificationRuleResponse_httpStatus :: Lens' UpdateNotificationRuleResponse Int Source #
The response's http status code.
DeleteNotificationRule
deleteNotificationRule_arn :: Lens' DeleteNotificationRule Text Source #
The Amazon Resource Name (ARN) of the notification rule you want to delete.
deleteNotificationRuleResponse_arn :: Lens' DeleteNotificationRuleResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the deleted notification rule.
deleteNotificationRuleResponse_httpStatus :: Lens' DeleteNotificationRuleResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_arn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) for the notification rule.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The tags associated with the notification rule.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListEventTypes
listEventTypes_filters :: Lens' ListEventTypes (Maybe [ListEventTypesFilter]) Source #
The filters to use to return information by service or resource type.
listEventTypes_nextToken :: Lens' ListEventTypes (Maybe Text) Source #
An enumeration token that, when provided in a request, returns the next batch of the results.
listEventTypes_maxResults :: Lens' ListEventTypes (Maybe Natural) Source #
A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of results that can be returned is 100.
listEventTypesResponse_eventTypes :: Lens' ListEventTypesResponse (Maybe [EventTypeSummary]) Source #
Information about each event, including service name, resource type, event ID, and event name.
listEventTypesResponse_nextToken :: Lens' ListEventTypesResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
listEventTypesResponse_httpStatus :: Lens' ListEventTypesResponse Int Source #
The response's http status code.
DeleteTarget
deleteTarget_forceUnsubscribeAll :: Lens' DeleteTarget (Maybe Bool) Source #
A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.
deleteTarget_targetAddress :: Lens' DeleteTarget Text Source #
The Amazon Resource Name (ARN) of the SNS topic to delete.
deleteTargetResponse_httpStatus :: Lens' DeleteTargetResponse Int Source #
The response's http status code.
ListNotificationRules
listNotificationRules_filters :: Lens' ListNotificationRules (Maybe [ListNotificationRulesFilter]) Source #
The filters to use to return information by service or resource type. For valid values, see ListNotificationRulesFilter.
A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.
listNotificationRules_nextToken :: Lens' ListNotificationRules (Maybe Text) Source #
An enumeration token that, when provided in a request, returns the next batch of the results.
listNotificationRules_maxResults :: Lens' ListNotificationRules (Maybe Natural) Source #
A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
listNotificationRulesResponse_nextToken :: Lens' ListNotificationRulesResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
listNotificationRulesResponse_notificationRules :: Lens' ListNotificationRulesResponse (Maybe [NotificationRuleSummary]) Source #
The list of notification rules for the AWS account, by Amazon Resource Name (ARN) and ID.
listNotificationRulesResponse_httpStatus :: Lens' ListNotificationRulesResponse Int Source #
The response's http status code.
ListTargets
listTargets_filters :: Lens' ListTargets (Maybe [ListTargetsFilter]) Source #
The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status.
A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.
listTargets_nextToken :: Lens' ListTargets (Maybe Text) Source #
An enumeration token that, when provided in a request, returns the next batch of the results.
listTargets_maxResults :: Lens' ListTargets (Maybe Natural) Source #
A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.
listTargetsResponse_nextToken :: Lens' ListTargetsResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of results.
listTargetsResponse_targets :: Lens' ListTargetsResponse (Maybe [TargetSummary]) Source #
The list of notification rule targets.
listTargetsResponse_httpStatus :: Lens' ListTargetsResponse Int Source #
The response's http status code.
TagResource
tagResource_arn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the notification rule to tag.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The list of tags to associate with the resource. Tag key names cannot start with "aws".
tagResourceResponse_tags :: Lens' TagResourceResponse (Maybe (HashMap Text Text)) Source #
The list of tags associated with the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
Subscribe
subscribe_clientRequestToken :: Lens' Subscribe (Maybe Text) Source #
An enumeration token that, when provided in a request, returns the next batch of the results.
subscribe_arn :: Lens' Subscribe Text Source #
The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
subscribeResponse_arn :: Lens' SubscribeResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.
subscribeResponse_httpStatus :: Lens' SubscribeResponse Int Source #
The response's http status code.
UntagResource
untagResource_arn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The key names of the tags to remove.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
Unsubscribe
unsubscribe_arn :: Lens' Unsubscribe Text Source #
The Amazon Resource Name (ARN) of the notification rule.
unsubscribe_targetAddress :: Lens' Unsubscribe Text Source #
The ARN of the SNS topic to unsubscribe from the notification rule.
unsubscribeResponse_httpStatus :: Lens' UnsubscribeResponse Int Source #
The response's http status code.
unsubscribeResponse_arn :: Lens' UnsubscribeResponse Text Source #
The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.
DescribeNotificationRule
describeNotificationRule_arn :: Lens' DescribeNotificationRule Text Source #
The Amazon Resource Name (ARN) of the notification rule.
describeNotificationRuleResponse_status :: Lens' DescribeNotificationRuleResponse (Maybe NotificationRuleStatus) Source #
The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
describeNotificationRuleResponse_eventTypes :: Lens' DescribeNotificationRuleResponse (Maybe [EventTypeSummary]) Source #
A list of the event types associated with the notification rule.
describeNotificationRuleResponse_lastModifiedTimestamp :: Lens' DescribeNotificationRuleResponse (Maybe UTCTime) Source #
The date and time the notification rule was most recently updated, in timestamp format.
describeNotificationRuleResponse_createdBy :: Lens' DescribeNotificationRuleResponse (Maybe Text) Source #
The name or email alias of the person who created the notification rule.
describeNotificationRuleResponse_detailType :: Lens' DescribeNotificationRuleResponse (Maybe DetailType) Source #
The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
describeNotificationRuleResponse_name :: Lens' DescribeNotificationRuleResponse (Maybe Text) Source #
The name of the notification rule.
describeNotificationRuleResponse_targets :: Lens' DescribeNotificationRuleResponse (Maybe [TargetSummary]) Source #
A list of the SNS topics associated with the notification rule.
describeNotificationRuleResponse_resource :: Lens' DescribeNotificationRuleResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource associated with the notification rule.
describeNotificationRuleResponse_createdTimestamp :: Lens' DescribeNotificationRuleResponse (Maybe UTCTime) Source #
The date and time the notification rule was created, in timestamp format.
describeNotificationRuleResponse_tags :: Lens' DescribeNotificationRuleResponse (Maybe (HashMap Text Text)) Source #
The tags associated with the notification rule.
describeNotificationRuleResponse_httpStatus :: Lens' DescribeNotificationRuleResponse Int Source #
The response's http status code.
describeNotificationRuleResponse_arn :: Lens' DescribeNotificationRuleResponse Text Source #
The Amazon Resource Name (ARN) of the notification rule.
Types
EventTypeSummary
eventTypeSummary_resourceType :: Lens' EventTypeSummary (Maybe Text) Source #
The resource type of the event.
eventTypeSummary_eventTypeName :: Lens' EventTypeSummary (Maybe Text) Source #
The name of the event.
eventTypeSummary_eventTypeId :: Lens' EventTypeSummary (Maybe Text) Source #
The system-generated ID of the event.
eventTypeSummary_serviceName :: Lens' EventTypeSummary (Maybe Text) Source #
The name of the service for which the event applies.
ListEventTypesFilter
listEventTypesFilter_name :: Lens' ListEventTypesFilter ListEventTypesFilterName Source #
The system-generated name of the filter type you want to filter by.
listEventTypesFilter_value :: Lens' ListEventTypesFilter Text Source #
The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.
ListNotificationRulesFilter
listNotificationRulesFilter_name :: Lens' ListNotificationRulesFilter ListNotificationRulesFilterName Source #
The name of the attribute you want to use to filter the returned notification rules.
listNotificationRulesFilter_value :: Lens' ListNotificationRulesFilter Text Source #
The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by RESOURCE in Name, you might specify the ARN of a pipeline in AWS CodePipeline for the value.
ListTargetsFilter
listTargetsFilter_name :: Lens' ListTargetsFilter ListTargetsFilterName Source #
The name of the attribute you want to use to filter the returned targets.
listTargetsFilter_value :: Lens' ListTargetsFilter Text Source #
The value of the attribute you want to use to filter the returned targets. For example, if you specify SNS for the Target type, you could specify an Amazon Resource Name (ARN) for a topic as the value.
NotificationRuleSummary
notificationRuleSummary_arn :: Lens' NotificationRuleSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the notification rule.
notificationRuleSummary_id :: Lens' NotificationRuleSummary (Maybe Text) Source #
The unique ID of the notification rule.
Target
target_targetAddress :: Lens' Target (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SNS topic.
TargetSummary
targetSummary_targetType :: Lens' TargetSummary (Maybe Text) Source #
The type of the target (for example, SNS).
targetSummary_targetAddress :: Lens' TargetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the SNS topic.
targetSummary_targetStatus :: Lens' TargetSummary (Maybe TargetStatus) Source #
The status of the target.