| 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.CodeStarNotifications
Description
Derived from API version 2019-10-15 of the AWS service descriptions, licensed under Apache 2.0.
This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API to work with the following objects:
Notification rules, by calling the following:
- CreateNotificationRule, which creates a notification rule for a resource in your account.
- DeleteNotificationRule, which deletes a notification rule.
- DescribeNotificationRule, which provides information about a notification rule.
- ListNotificationRules, which lists the notification rules associated with your account.
- UpdateNotificationRule, which changes the name, events, or targets associated with a notification rule.
- Subscribe, which subscribes a target to a notification rule.
- Unsubscribe, which removes a target from a notification rule.
Targets, by calling the following:
- DeleteTarget, which removes a notification rule target from a notification rule.
- ListTargets, which lists the targets associated with a notification rule.
Events, by calling the following:
- ListEventTypes, which lists the event types you can include in a notification rule.
Tags, by calling the following:
- ListTagsForResource, which lists the tags already associated with a notification rule in your account.
- TagResource, which associates a tag you provide with a notification rule in your account.
- UntagResource, which removes a tag from a notification rule in your account.
For information about how to use AWS CodeStar Notifications, see the Amazon Web Services Developer Tools Console User Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _ConfigurationException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateNotificationRule = CreateNotificationRule' (Maybe Text) (Maybe NotificationRuleStatus) (Maybe (HashMap Text Text)) (Sensitive Text) [Text] Text [Target] DetailType
- newCreateNotificationRule :: Text -> Text -> DetailType -> CreateNotificationRule
- data CreateNotificationRuleResponse = CreateNotificationRuleResponse' (Maybe Text) Int
- newCreateNotificationRuleResponse :: Int -> CreateNotificationRuleResponse
- data DeleteNotificationRule = DeleteNotificationRule' Text
- newDeleteNotificationRule :: Text -> DeleteNotificationRule
- data DeleteNotificationRuleResponse = DeleteNotificationRuleResponse' (Maybe Text) Int
- newDeleteNotificationRuleResponse :: Int -> DeleteNotificationRuleResponse
- data DeleteTarget = DeleteTarget' (Maybe Bool) (Sensitive Text)
- newDeleteTarget :: Text -> DeleteTarget
- data DeleteTargetResponse = DeleteTargetResponse' Int
- newDeleteTargetResponse :: Int -> DeleteTargetResponse
- data DescribeNotificationRule = DescribeNotificationRule' Text
- newDescribeNotificationRule :: Text -> DescribeNotificationRule
- data DescribeNotificationRuleResponse = DescribeNotificationRuleResponse' (Maybe Text) (Maybe POSIX) (Maybe DetailType) (Maybe [EventTypeSummary]) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe NotificationRuleStatus) (Maybe (HashMap Text Text)) (Maybe [TargetSummary]) Int Text
- newDescribeNotificationRuleResponse :: Int -> Text -> DescribeNotificationRuleResponse
- data ListEventTypes = ListEventTypes' (Maybe [ListEventTypesFilter]) (Maybe Natural) (Maybe Text)
- newListEventTypes :: ListEventTypes
- data ListEventTypesResponse = ListEventTypesResponse' (Maybe [EventTypeSummary]) (Maybe Text) Int
- newListEventTypesResponse :: Int -> ListEventTypesResponse
- data ListNotificationRules = ListNotificationRules' (Maybe [ListNotificationRulesFilter]) (Maybe Natural) (Maybe Text)
- newListNotificationRules :: ListNotificationRules
- data ListNotificationRulesResponse = ListNotificationRulesResponse' (Maybe Text) (Maybe [NotificationRuleSummary]) Int
- newListNotificationRulesResponse :: Int -> ListNotificationRulesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTargets = ListTargets' (Maybe [ListTargetsFilter]) (Maybe Natural) (Maybe Text)
- newListTargets :: ListTargets
- data ListTargetsResponse = ListTargetsResponse' (Maybe Text) (Maybe [TargetSummary]) Int
- newListTargetsResponse :: Int -> ListTargetsResponse
- data Subscribe = Subscribe' (Maybe Text) Text Target
- newSubscribe :: Text -> Target -> Subscribe
- data SubscribeResponse = SubscribeResponse' (Maybe Text) Int
- newSubscribeResponse :: Int -> SubscribeResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' (Maybe (HashMap Text Text)) Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data Unsubscribe = Unsubscribe' Text (Sensitive Text)
- newUnsubscribe :: Text -> Text -> Unsubscribe
- data UnsubscribeResponse = UnsubscribeResponse' Int Text
- newUnsubscribeResponse :: Int -> Text -> UnsubscribeResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateNotificationRule = UpdateNotificationRule' (Maybe DetailType) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe NotificationRuleStatus) (Maybe [Target]) Text
- newUpdateNotificationRule :: Text -> UpdateNotificationRule
- data UpdateNotificationRuleResponse = UpdateNotificationRuleResponse' Int
- newUpdateNotificationRuleResponse :: Int -> UpdateNotificationRuleResponse
- newtype DetailType where
- DetailType' { }
- pattern DetailType_BASIC :: DetailType
- pattern DetailType_FULL :: DetailType
- newtype ListEventTypesFilterName where
- newtype ListNotificationRulesFilterName where
- ListNotificationRulesFilterName' { }
- pattern ListNotificationRulesFilterName_CREATED_BY :: ListNotificationRulesFilterName
- pattern ListNotificationRulesFilterName_EVENT_TYPE_ID :: ListNotificationRulesFilterName
- pattern ListNotificationRulesFilterName_RESOURCE :: ListNotificationRulesFilterName
- pattern ListNotificationRulesFilterName_TARGET_ADDRESS :: ListNotificationRulesFilterName
- newtype ListTargetsFilterName where
- newtype NotificationRuleStatus where
- newtype TargetStatus where
- TargetStatus' { }
- pattern TargetStatus_ACTIVE :: TargetStatus
- pattern TargetStatus_DEACTIVATED :: TargetStatus
- pattern TargetStatus_INACTIVE :: TargetStatus
- pattern TargetStatus_PENDING :: TargetStatus
- pattern TargetStatus_UNREACHABLE :: TargetStatus
- data EventTypeSummary = EventTypeSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEventTypeSummary :: EventTypeSummary
- data ListEventTypesFilter = ListEventTypesFilter' ListEventTypesFilterName Text
- newListEventTypesFilter :: ListEventTypesFilterName -> Text -> ListEventTypesFilter
- data ListNotificationRulesFilter = ListNotificationRulesFilter' ListNotificationRulesFilterName Text
- newListNotificationRulesFilter :: ListNotificationRulesFilterName -> Text -> ListNotificationRulesFilter
- data ListTargetsFilter = ListTargetsFilter' ListTargetsFilterName Text
- newListTargetsFilter :: ListTargetsFilterName -> Text -> ListTargetsFilter
- data NotificationRuleSummary = NotificationRuleSummary' (Maybe Text) (Maybe Text)
- newNotificationRuleSummary :: NotificationRuleSummary
- data Target = Target' (Maybe (Sensitive Text)) (Maybe Text)
- newTarget :: Target
- data TargetSummary = TargetSummary' (Maybe (Sensitive Text)) (Maybe TargetStatus) (Maybe Text)
- newTargetSummary :: TargetSummary
Service Configuration
defaultService :: Service Source #
API version 2019-10-15 of the Amazon CodeStar Notifications SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodeStarNotifications.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
AWS CodeStar Notifications can't create the notification rule because you do not have sufficient permissions.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.
ConfigurationException
_ConfigurationException :: AsError a => Fold a ServiceError Source #
Some or all of the configuration is incomplete, missing, or not valid.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The value for the enumeration token used in the request to return the next batch of the results is not valid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
A resource with the same name or ID already exists. Notification rule names must be unique in your Amazon Web Services account.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
AWS CodeStar Notifications can't find a resource that matches the provided ARN.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
One or more parameter values are not valid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateNotificationRule
data CreateNotificationRule Source #
See: newCreateNotificationRule smart constructor.
Constructors
| CreateNotificationRule' (Maybe Text) (Maybe NotificationRuleStatus) (Maybe (HashMap Text Text)) (Sensitive Text) [Text] Text [Target] DetailType |
Instances
newCreateNotificationRule Source #
Arguments
| :: Text | |
| -> Text | |
| -> DetailType | |
| -> CreateNotificationRule |
Create a value of CreateNotificationRule 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:clientRequestToken:CreateNotificationRule', createNotificationRule_clientRequestToken - 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 Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.
$sel:status:CreateNotificationRule', createNotificationRule_status - 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.
$sel:tags:CreateNotificationRule', createNotificationRule_tags - A list of tags to apply to this notification rule. Key names cannot
start with "aws".
CreateNotificationRule, createNotificationRule_name - The name for the notification rule. Notification rule names must be
unique in your Amazon Web Services account.
$sel:eventTypeIds:CreateNotificationRule', createNotificationRule_eventTypeIds - A list of event types associated with this notification rule. For a list
of allowed events, see EventTypeSummary.
$sel:resource:CreateNotificationRule', createNotificationRule_resource - The Amazon Resource Name (ARN) of the resource to associate with the
notification rule. Supported resources include pipelines in
CodePipeline, repositories in CodeCommit, and build projects in
CodeBuild.
$sel:targets:CreateNotificationRule', createNotificationRule_targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification
Service topics and Chatbot clients to associate with the notification
rule.
$sel:detailType:CreateNotificationRule', createNotificationRule_detailType - 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 Amazon 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.
data CreateNotificationRuleResponse Source #
See: newCreateNotificationRuleResponse smart constructor.
Constructors
| CreateNotificationRuleResponse' (Maybe Text) Int |
Instances
newCreateNotificationRuleResponse Source #
Create a value of CreateNotificationRuleResponse 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:
CreateNotificationRuleResponse, createNotificationRuleResponse_arn - The Amazon Resource Name (ARN) of the notification rule.
$sel:httpStatus:CreateNotificationRuleResponse', createNotificationRuleResponse_httpStatus - The response's http status code.
DeleteNotificationRule
data DeleteNotificationRule Source #
See: newDeleteNotificationRule smart constructor.
Constructors
| DeleteNotificationRule' Text |
Instances
newDeleteNotificationRule Source #
Arguments
| :: Text | |
| -> DeleteNotificationRule |
Create a value of DeleteNotificationRule 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:
DeleteNotificationRule, deleteNotificationRule_arn - The Amazon Resource Name (ARN) of the notification rule you want to
delete.
data DeleteNotificationRuleResponse Source #
See: newDeleteNotificationRuleResponse smart constructor.
Constructors
| DeleteNotificationRuleResponse' (Maybe Text) Int |
Instances
newDeleteNotificationRuleResponse Source #
Create a value of DeleteNotificationRuleResponse 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:
DeleteNotificationRule, deleteNotificationRuleResponse_arn - The Amazon Resource Name (ARN) of the deleted notification rule.
$sel:httpStatus:DeleteNotificationRuleResponse', deleteNotificationRuleResponse_httpStatus - The response's http status code.
DeleteTarget
data DeleteTarget Source #
See: newDeleteTarget smart constructor.
Constructors
| DeleteTarget' (Maybe Bool) (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> DeleteTarget |
Create a value of DeleteTarget 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:forceUnsubscribeAll:DeleteTarget', deleteTarget_forceUnsubscribeAll - A Boolean value that can be used to delete all associations with this
Chatbot topic. The default value is FALSE. If set to TRUE, all
associations between that target and every notification rule in your
Amazon Web Services account are deleted.
DeleteTarget, deleteTarget_targetAddress - The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client to
delete.
data DeleteTargetResponse Source #
See: newDeleteTargetResponse smart constructor.
Constructors
| DeleteTargetResponse' Int |
Instances
newDeleteTargetResponse Source #
Arguments
| :: Int | |
| -> DeleteTargetResponse |
Create a value of DeleteTargetResponse 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:httpStatus:DeleteTargetResponse', deleteTargetResponse_httpStatus - The response's http status code.
DescribeNotificationRule
data DescribeNotificationRule Source #
See: newDescribeNotificationRule smart constructor.
Constructors
| DescribeNotificationRule' Text |
Instances
newDescribeNotificationRule Source #
Arguments
| :: Text | |
| -> DescribeNotificationRule |
Create a value of DescribeNotificationRule 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:
DescribeNotificationRule, describeNotificationRule_arn - The Amazon Resource Name (ARN) of the notification rule.
data DescribeNotificationRuleResponse Source #
See: newDescribeNotificationRuleResponse smart constructor.
Constructors
| DescribeNotificationRuleResponse' (Maybe Text) (Maybe POSIX) (Maybe DetailType) (Maybe [EventTypeSummary]) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe NotificationRuleStatus) (Maybe (HashMap Text Text)) (Maybe [TargetSummary]) Int Text |
Instances
newDescribeNotificationRuleResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeNotificationRuleResponse |
Create a value of DescribeNotificationRuleResponse 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:createdBy:DescribeNotificationRuleResponse', describeNotificationRuleResponse_createdBy - The name or email alias of the person who created the notification rule.
$sel:createdTimestamp:DescribeNotificationRuleResponse', describeNotificationRuleResponse_createdTimestamp - The date and time the notification rule was created, in timestamp
format.
$sel:detailType:DescribeNotificationRuleResponse', describeNotificationRuleResponse_detailType - 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
Amazon 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.
$sel:eventTypes:DescribeNotificationRuleResponse', describeNotificationRuleResponse_eventTypes - A list of the event types associated with the notification rule.
$sel:lastModifiedTimestamp:DescribeNotificationRuleResponse', describeNotificationRuleResponse_lastModifiedTimestamp - The date and time the notification rule was most recently updated, in
timestamp format.
DescribeNotificationRuleResponse, describeNotificationRuleResponse_name - The name of the notification rule.
$sel:resource:DescribeNotificationRuleResponse', describeNotificationRuleResponse_resource - The Amazon Resource Name (ARN) of the resource associated with the
notification rule.
$sel:status:DescribeNotificationRuleResponse', describeNotificationRuleResponse_status - The status of the notification rule. Valid statuses are on (sending
notifications) or off (not sending notifications).
$sel:tags:DescribeNotificationRuleResponse', describeNotificationRuleResponse_tags - The tags associated with the notification rule.
$sel:targets:DescribeNotificationRuleResponse', describeNotificationRuleResponse_targets - A list of the Chatbot topics and Chatbot clients associated with the
notification rule.
$sel:httpStatus:DescribeNotificationRuleResponse', describeNotificationRuleResponse_httpStatus - The response's http status code.
DescribeNotificationRule, describeNotificationRuleResponse_arn - The Amazon Resource Name (ARN) of the notification rule.
ListEventTypes (Paginated)
data ListEventTypes Source #
See: newListEventTypes smart constructor.
Constructors
| ListEventTypes' (Maybe [ListEventTypesFilter]) (Maybe Natural) (Maybe Text) |
Instances
newListEventTypes :: ListEventTypes Source #
Create a value of ListEventTypes 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:filters:ListEventTypes', listEventTypes_filters - The filters to use to return information by service or resource type.
$sel:maxResults:ListEventTypes', listEventTypes_maxResults - 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.
ListEventTypes, listEventTypes_nextToken - An enumeration token that, when provided in a request, returns the next
batch of the results.
data ListEventTypesResponse Source #
See: newListEventTypesResponse smart constructor.
Constructors
| ListEventTypesResponse' (Maybe [EventTypeSummary]) (Maybe Text) Int |
Instances
newListEventTypesResponse Source #
Create a value of ListEventTypesResponse 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:eventTypes:ListEventTypesResponse', listEventTypesResponse_eventTypes - Information about each event, including service name, resource type,
event ID, and event name.
ListEventTypes, listEventTypesResponse_nextToken - An enumeration token that can be used in a request to return the next
batch of the results.
$sel:httpStatus:ListEventTypesResponse', listEventTypesResponse_httpStatus - The response's http status code.
ListNotificationRules (Paginated)
data ListNotificationRules Source #
See: newListNotificationRules smart constructor.
Constructors
| ListNotificationRules' (Maybe [ListNotificationRulesFilter]) (Maybe Natural) (Maybe Text) |
Instances
newListNotificationRules :: ListNotificationRules Source #
Create a value of ListNotificationRules 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:filters:ListNotificationRules', listNotificationRules_filters - 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.
$sel:maxResults:ListNotificationRules', listNotificationRules_maxResults - A non-negative integer used to limit the number of returned results. The
maximum number of results that can be returned is 100.
ListNotificationRules, listNotificationRules_nextToken - An enumeration token that, when provided in a request, returns the next
batch of the results.
data ListNotificationRulesResponse Source #
See: newListNotificationRulesResponse smart constructor.
Constructors
| ListNotificationRulesResponse' (Maybe Text) (Maybe [NotificationRuleSummary]) Int |
Instances
newListNotificationRulesResponse Source #
Create a value of ListNotificationRulesResponse 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:
ListNotificationRules, listNotificationRulesResponse_nextToken - An enumeration token that can be used in a request to return the next
batch of the results.
$sel:notificationRules:ListNotificationRulesResponse', listNotificationRulesResponse_notificationRules - The list of notification rules for the Amazon Web Services account, by
Amazon Resource Name (ARN) and ID.
$sel:httpStatus:ListNotificationRulesResponse', listNotificationRulesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:
ListTagsForResource, listTagsForResource_arn - The Amazon Resource Name (ARN) for the notification rule.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags associated with the notification rule.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTargets (Paginated)
data ListTargets Source #
See: newListTargets smart constructor.
Constructors
| ListTargets' (Maybe [ListTargetsFilter]) (Maybe Natural) (Maybe Text) |
Instances
newListTargets :: ListTargets Source #
Create a value of ListTargets 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:filters:ListTargets', listTargets_filters - 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.
$sel:maxResults:ListTargets', listTargets_maxResults - A non-negative integer used to limit the number of returned results. The
maximum number of results that can be returned is 100.
ListTargets, listTargets_nextToken - An enumeration token that, when provided in a request, returns the next
batch of the results.
data ListTargetsResponse Source #
See: newListTargetsResponse smart constructor.
Constructors
| ListTargetsResponse' (Maybe Text) (Maybe [TargetSummary]) Int |
Instances
newListTargetsResponse Source #
Arguments
| :: Int | |
| -> ListTargetsResponse |
Create a value of ListTargetsResponse 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:
ListTargets, listTargetsResponse_nextToken - An enumeration token that can be used in a request to return the next
batch of results.
$sel:targets:ListTargetsResponse', listTargetsResponse_targets - The list of notification rule targets.
$sel:httpStatus:ListTargetsResponse', listTargetsResponse_httpStatus - The response's http status code.
Subscribe
See: newSubscribe smart constructor.
Constructors
| Subscribe' (Maybe Text) Text Target |
Instances
Create a value of Subscribe 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:clientRequestToken:Subscribe', subscribe_clientRequestToken - An enumeration token that, when provided in a request, returns the next
batch of the results.
Subscribe, subscribe_arn - The Amazon Resource Name (ARN) of the notification rule for which you
want to create the association.
$sel:target:Subscribe', subscribe_target - Undocumented member.
data SubscribeResponse Source #
See: newSubscribeResponse smart constructor.
Constructors
| SubscribeResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> SubscribeResponse |
Create a value of SubscribeResponse 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:
Subscribe, subscribeResponse_arn - The Amazon Resource Name (ARN) of the notification rule for which you
have created assocations.
$sel:httpStatus:SubscribeResponse', subscribeResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:
TagResource, tagResource_arn - The Amazon Resource Name (ARN) of the notification rule to tag.
TagResource, tagResource_tags - The list of tags to associate with the resource. Tag key names cannot
start with "aws".
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:
TagResource, tagResourceResponse_tags - The list of tags associated with the resource.
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
Unsubscribe
data Unsubscribe Source #
See: newUnsubscribe smart constructor.
Constructors
| Unsubscribe' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Unsubscribe |
Create a value of Unsubscribe 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:
Unsubscribe, unsubscribe_arn - The Amazon Resource Name (ARN) of the notification rule.
Unsubscribe, unsubscribe_targetAddress - The ARN of the Chatbot topic to unsubscribe from the notification rule.
data UnsubscribeResponse Source #
See: newUnsubscribeResponse smart constructor.
Constructors
| UnsubscribeResponse' Int Text |
Instances
newUnsubscribeResponse Source #
Create a value of UnsubscribeResponse 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:httpStatus:UnsubscribeResponse', unsubscribeResponse_httpStatus - The response's http status code.
Unsubscribe, unsubscribeResponse_arn - The Amazon Resource Name (ARN) of the the notification rule from which
you have removed a subscription.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:
UntagResource, untagResource_arn - The Amazon Resource Name (ARN) of the notification rule from which to
remove the tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The key names of the tags to remove.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateNotificationRule
data UpdateNotificationRule Source #
See: newUpdateNotificationRule smart constructor.
Constructors
| UpdateNotificationRule' (Maybe DetailType) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe NotificationRuleStatus) (Maybe [Target]) Text |
Instances
newUpdateNotificationRule Source #
Arguments
| :: Text | |
| -> UpdateNotificationRule |
Create a value of UpdateNotificationRule 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:detailType:UpdateNotificationRule', updateNotificationRule_detailType - 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
Amazon 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.
$sel:eventTypeIds:UpdateNotificationRule', updateNotificationRule_eventTypeIds - A list of event types associated with this notification rule. For a
complete list of event types and IDs, see
Notification concepts
in the Developer Tools Console User Guide.
UpdateNotificationRule, updateNotificationRule_name - The name of the notification rule.
$sel:status:UpdateNotificationRule', updateNotificationRule_status - The status of the notification rule. Valid statuses include enabled
(sending notifications) or disabled (not sending notifications).
$sel:targets:UpdateNotificationRule', updateNotificationRule_targets - The address and type of the targets to receive notifications from this
notification rule.
UpdateNotificationRule, updateNotificationRule_arn - The Amazon Resource Name (ARN) of the notification rule.
data UpdateNotificationRuleResponse Source #
See: newUpdateNotificationRuleResponse smart constructor.
Constructors
| UpdateNotificationRuleResponse' Int |
Instances
newUpdateNotificationRuleResponse Source #
Create a value of UpdateNotificationRuleResponse 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:httpStatus:UpdateNotificationRuleResponse', updateNotificationRuleResponse_httpStatus - The response's http status code.
Types
DetailType
newtype DetailType Source #
Constructors
| DetailType' | |
Fields | |
Bundled Patterns
| pattern DetailType_BASIC :: DetailType | |
| pattern DetailType_FULL :: DetailType |
Instances
ListEventTypesFilterName
newtype ListEventTypesFilterName Source #
Constructors
| ListEventTypesFilterName' | |
Fields | |
Bundled Patterns
| pattern ListEventTypesFilterName_RESOURCE_TYPE :: ListEventTypesFilterName | |
| pattern ListEventTypesFilterName_SERVICE_NAME :: ListEventTypesFilterName |
Instances
ListNotificationRulesFilterName
newtype ListNotificationRulesFilterName Source #
Constructors
| ListNotificationRulesFilterName' | |
Fields | |
Bundled Patterns
Instances
ListTargetsFilterName
newtype ListTargetsFilterName Source #
Constructors
| ListTargetsFilterName' | |
Fields | |
Bundled Patterns
Instances
NotificationRuleStatus
newtype NotificationRuleStatus Source #
Constructors
| NotificationRuleStatus' | |
Fields | |
Bundled Patterns
| pattern NotificationRuleStatus_DISABLED :: NotificationRuleStatus | |
| pattern NotificationRuleStatus_ENABLED :: NotificationRuleStatus |
Instances
TargetStatus
newtype TargetStatus Source #
Constructors
| TargetStatus' | |
Fields | |
Bundled Patterns
| pattern TargetStatus_ACTIVE :: TargetStatus | |
| pattern TargetStatus_DEACTIVATED :: TargetStatus | |
| pattern TargetStatus_INACTIVE :: TargetStatus | |
| pattern TargetStatus_PENDING :: TargetStatus | |
| pattern TargetStatus_UNREACHABLE :: TargetStatus |
Instances
EventTypeSummary
data EventTypeSummary Source #
Returns information about an event that has triggered a notification rule.
See: newEventTypeSummary smart constructor.
Instances
newEventTypeSummary :: EventTypeSummary Source #
Create a value of EventTypeSummary 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:eventTypeId:EventTypeSummary', eventTypeSummary_eventTypeId - The system-generated ID of the event. For a complete list of event types
and IDs, see
Notification concepts
in the Developer Tools Console User Guide.
$sel:eventTypeName:EventTypeSummary', eventTypeSummary_eventTypeName - The name of the event.
$sel:resourceType:EventTypeSummary', eventTypeSummary_resourceType - The resource type of the event.
$sel:serviceName:EventTypeSummary', eventTypeSummary_serviceName - The name of the service for which the event applies.
ListEventTypesFilter
data ListEventTypesFilter Source #
Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.
See: newListEventTypesFilter smart constructor.
Constructors
| ListEventTypesFilter' ListEventTypesFilterName Text |
Instances
newListEventTypesFilter Source #
Arguments
| :: ListEventTypesFilterName | |
| -> Text | |
| -> ListEventTypesFilter |
Create a value of ListEventTypesFilter 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:name:ListEventTypesFilter', listEventTypesFilter_name - The system-generated name of the filter type you want to filter by.
$sel:value:ListEventTypesFilter', listEventTypesFilter_value - The name of the resource type (for example, pipeline) or service name
(for example, CodePipeline) that you want to filter by.
ListNotificationRulesFilter
data ListNotificationRulesFilter Source #
Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.
See: newListNotificationRulesFilter smart constructor.
Instances
newListNotificationRulesFilter Source #
Arguments
| :: ListNotificationRulesFilterName | |
| -> Text | |
| -> ListNotificationRulesFilter |
Create a value of ListNotificationRulesFilter 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:name:ListNotificationRulesFilter', listNotificationRulesFilter_name - The name of the attribute you want to use to filter the returned
notification rules.
$sel:value:ListNotificationRulesFilter', listNotificationRulesFilter_value - 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 CodePipeline for the
value.
ListTargetsFilter
data ListTargetsFilter Source #
Information about a filter to apply to the list of returned targets. You
can filter by target type, address, or status. For example, to filter
results to notification rules that have active Chatbot topics as
targets, you could specify a ListTargetsFilter Name as TargetType and
a Value of SNS, and a Name of TARGET_STATUS and a Value of ACTIVE.
See: newListTargetsFilter smart constructor.
Constructors
| ListTargetsFilter' ListTargetsFilterName Text |
Instances
Arguments
| :: ListTargetsFilterName | |
| -> Text | |
| -> ListTargetsFilter |
Create a value of ListTargetsFilter 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:name:ListTargetsFilter', listTargetsFilter_name - The name of the attribute you want to use to filter the returned
targets.
$sel:value:ListTargetsFilter', listTargetsFilter_value - 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
data NotificationRuleSummary Source #
Information about a specified notification rule.
See: newNotificationRuleSummary smart constructor.
Constructors
| NotificationRuleSummary' (Maybe Text) (Maybe Text) |
Instances
newNotificationRuleSummary :: NotificationRuleSummary Source #
Create a value of NotificationRuleSummary 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:arn:NotificationRuleSummary', notificationRuleSummary_arn - The Amazon Resource Name (ARN) of the notification rule.
$sel:id:NotificationRuleSummary', notificationRuleSummary_id - The unique ID of the notification rule.
Target
Information about the Chatbot topics or Chatbot clients associated with a notification rule.
See: newTarget smart constructor.
Instances
| ToJSON Target Source # | |
Defined in Amazonka.CodeStarNotifications.Types.Target | |
| Generic Target Source # | |
| Show Target Source # | |
| NFData Target Source # | |
Defined in Amazonka.CodeStarNotifications.Types.Target | |
| Eq Target Source # | |
| Hashable Target Source # | |
Defined in Amazonka.CodeStarNotifications.Types.Target | |
| type Rep Target Source # | |
Defined in Amazonka.CodeStarNotifications.Types.Target type Rep Target = D1 ('MetaData "Target" "Amazonka.CodeStarNotifications.Types.Target" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "Target'" 'PrefixI 'True) (S1 ('MetaSel ('Just "targetAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Target 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:targetAddress:Target', target_targetAddress - The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
$sel:targetType:Target', target_targetType - The target type. Can be an Chatbot topic or Chatbot client.
- Chatbot topics are specified as
SNS. - Chatbot clients are specified as
AWSChatbotSlack.
TargetSummary
data TargetSummary Source #
Information about the targets specified for a notification rule.
See: newTargetSummary smart constructor.
Constructors
| TargetSummary' (Maybe (Sensitive Text)) (Maybe TargetStatus) (Maybe Text) |
Instances
newTargetSummary :: TargetSummary Source #
Create a value of TargetSummary 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:targetAddress:TargetSummary', targetSummary_targetAddress - The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
$sel:targetStatus:TargetSummary', targetSummary_targetStatus - The status of the target.
$sel:targetType:TargetSummary', targetSummary_targetType - The type of the target (for example, SNS).
- Chatbot topics are specified as
SNS. - Chatbot clients are specified as
AWSChatbotSlack.