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 |
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
- 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' {}
- newEventTypeSummary :: EventTypeSummary
- eventTypeSummary_eventTypeId :: Lens' EventTypeSummary (Maybe Text)
- eventTypeSummary_eventTypeName :: Lens' EventTypeSummary (Maybe Text)
- eventTypeSummary_resourceType :: Lens' EventTypeSummary (Maybe Text)
- eventTypeSummary_serviceName :: Lens' EventTypeSummary (Maybe Text)
- data ListEventTypesFilter = ListEventTypesFilter' {}
- newListEventTypesFilter :: ListEventTypesFilterName -> Text -> ListEventTypesFilter
- listEventTypesFilter_name :: Lens' ListEventTypesFilter ListEventTypesFilterName
- listEventTypesFilter_value :: Lens' ListEventTypesFilter Text
- data ListNotificationRulesFilter = ListNotificationRulesFilter' {}
- newListNotificationRulesFilter :: ListNotificationRulesFilterName -> Text -> ListNotificationRulesFilter
- listNotificationRulesFilter_name :: Lens' ListNotificationRulesFilter ListNotificationRulesFilterName
- listNotificationRulesFilter_value :: Lens' ListNotificationRulesFilter Text
- data ListTargetsFilter = ListTargetsFilter' {}
- newListTargetsFilter :: ListTargetsFilterName -> Text -> ListTargetsFilter
- listTargetsFilter_name :: Lens' ListTargetsFilter ListTargetsFilterName
- listTargetsFilter_value :: Lens' ListTargetsFilter Text
- data NotificationRuleSummary = NotificationRuleSummary' {}
- newNotificationRuleSummary :: NotificationRuleSummary
- notificationRuleSummary_arn :: Lens' NotificationRuleSummary (Maybe Text)
- notificationRuleSummary_id :: Lens' NotificationRuleSummary (Maybe Text)
- data Target = Target' {
- targetAddress :: Maybe (Sensitive Text)
- targetType :: Maybe Text
- newTarget :: Target
- target_targetAddress :: Lens' Target (Maybe Text)
- target_targetType :: Lens' Target (Maybe Text)
- data TargetSummary = TargetSummary' {}
- newTargetSummary :: TargetSummary
- targetSummary_targetAddress :: Lens' TargetSummary (Maybe Text)
- targetSummary_targetStatus :: Lens' TargetSummary (Maybe TargetStatus)
- targetSummary_targetType :: Lens' TargetSummary (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2019-10-15
of the Amazon CodeStar Notifications SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
AWS CodeStar Notifications can't create the notification rule because you do not have sufficient permissions.
_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 :: AsError a => Fold a ServiceError Source #
Some or all of the configuration is incomplete, missing, or not valid.
_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 :: 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 :: 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 :: AsError a => Fold a ServiceError Source #
AWS CodeStar Notifications can't find a resource that matches the provided ARN.
_ValidationException :: AsError a => Fold a ServiceError Source #
One or more parameter values are not valid.
DetailType
newtype DetailType Source #
pattern DetailType_BASIC :: DetailType | |
pattern DetailType_FULL :: DetailType |
Instances
ListEventTypesFilterName
newtype ListEventTypesFilterName Source #
pattern ListEventTypesFilterName_RESOURCE_TYPE :: ListEventTypesFilterName | |
pattern ListEventTypesFilterName_SERVICE_NAME :: ListEventTypesFilterName |
Instances
ListNotificationRulesFilterName
newtype ListNotificationRulesFilterName Source #
Instances
ListTargetsFilterName
newtype ListTargetsFilterName Source #
Instances
NotificationRuleStatus
newtype NotificationRuleStatus Source #
pattern NotificationRuleStatus_DISABLED :: NotificationRuleStatus | |
pattern NotificationRuleStatus_ENABLED :: NotificationRuleStatus |
Instances
TargetStatus
newtype TargetStatus Source #
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.
EventTypeSummary' | |
|
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.
eventTypeSummary_eventTypeId :: Lens' EventTypeSummary (Maybe Text) Source #
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.
eventTypeSummary_eventTypeName :: Lens' EventTypeSummary (Maybe Text) Source #
The name of the event.
eventTypeSummary_resourceType :: Lens' EventTypeSummary (Maybe Text) Source #
The resource type of the event.
eventTypeSummary_serviceName :: Lens' EventTypeSummary (Maybe Text) Source #
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.
ListEventTypesFilter' | |
|
Instances
newListEventTypesFilter Source #
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.
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
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.
ListNotificationRulesFilter' | |
|
Instances
ToJSON ListNotificationRulesFilter Source # | |
Generic ListNotificationRulesFilter Source # | |
Read ListNotificationRulesFilter Source # | |
Show ListNotificationRulesFilter Source # | |
NFData ListNotificationRulesFilter Source # | |
Eq ListNotificationRulesFilter Source # | |
Hashable ListNotificationRulesFilter Source # | |
type Rep ListNotificationRulesFilter Source # | |
Defined in Amazonka.CodeStarNotifications.Types.ListNotificationRulesFilter type Rep ListNotificationRulesFilter = D1 ('MetaData "ListNotificationRulesFilter" "Amazonka.CodeStarNotifications.Types.ListNotificationRulesFilter" "amazonka-codestar-notifications-2.0-1YU4g2Ny2gz2roMHW6JQnw" 'False) (C1 ('MetaCons "ListNotificationRulesFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ListNotificationRulesFilterName) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
newListNotificationRulesFilter Source #
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.
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 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.
ListTargetsFilter' | |
|
Instances
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.
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
data NotificationRuleSummary Source #
Information about a specified notification rule.
See: newNotificationRuleSummary
smart constructor.
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.
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
Information about the Chatbot topics or Chatbot clients associated with a notification rule.
See: newTarget
smart constructor.
Target' | |
|
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
.
target_targetAddress :: Lens' Target (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
target_targetType :: Lens' Target (Maybe Text) Source #
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.
TargetSummary' | |
|
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
.
targetSummary_targetAddress :: Lens' TargetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Chatbot topic or Chatbot client.
targetSummary_targetStatus :: Lens' TargetSummary (Maybe TargetStatus) Source #
The status of the target.
targetSummary_targetType :: Lens' TargetSummary (Maybe Text) Source #
The type of the target (for example, SNS
).
- Chatbot topics are specified as
SNS
. - Chatbot clients are specified as
AWSChatbotSlack
.