| 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.PinpointSmsVoiceV2.CreateEventDestination
Description
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Kinesis Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Kinesis Data Firehose destination.
Synopsis
- data CreateEventDestination = CreateEventDestination' {}
- newCreateEventDestination :: Text -> Text -> NonEmpty EventType -> CreateEventDestination
- createEventDestination_clientToken :: Lens' CreateEventDestination (Maybe Text)
- createEventDestination_cloudWatchLogsDestination :: Lens' CreateEventDestination (Maybe CloudWatchLogsDestination)
- createEventDestination_kinesisFirehoseDestination :: Lens' CreateEventDestination (Maybe KinesisFirehoseDestination)
- createEventDestination_snsDestination :: Lens' CreateEventDestination (Maybe SnsDestination)
- createEventDestination_configurationSetName :: Lens' CreateEventDestination Text
- createEventDestination_eventDestinationName :: Lens' CreateEventDestination Text
- createEventDestination_matchingEventTypes :: Lens' CreateEventDestination (NonEmpty EventType)
- data CreateEventDestinationResponse = CreateEventDestinationResponse' {}
- newCreateEventDestinationResponse :: Int -> CreateEventDestinationResponse
- createEventDestinationResponse_configurationSetArn :: Lens' CreateEventDestinationResponse (Maybe Text)
- createEventDestinationResponse_configurationSetName :: Lens' CreateEventDestinationResponse (Maybe Text)
- createEventDestinationResponse_eventDestination :: Lens' CreateEventDestinationResponse (Maybe EventDestination)
- createEventDestinationResponse_httpStatus :: Lens' CreateEventDestinationResponse Int
Creating a Request
data CreateEventDestination Source #
See: newCreateEventDestination smart constructor.
Constructors
| CreateEventDestination' | |
Fields
| |
Instances
newCreateEventDestination Source #
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty EventType | |
| -> CreateEventDestination |
Create a value of CreateEventDestination 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:clientToken:CreateEventDestination', createEventDestination_clientToken - Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
CreateEventDestination, createEventDestination_cloudWatchLogsDestination - An object that contains information about an event destination for
logging to Amazon CloudWatch logs.
CreateEventDestination, createEventDestination_kinesisFirehoseDestination - An object that contains information about an event destination for
logging to Amazon Kinesis Data Firehose.
CreateEventDestination, createEventDestination_snsDestination - An object that contains information about an event destination for
logging to Amazon SNS.
CreateEventDestination, createEventDestination_configurationSetName - Either the name of the configuration set or the configuration set ARN to
apply event logging to. The ConfigurateSetName and ConfigurationSetArn
can be found using the DescribeConfigurationSets action.
CreateEventDestination, createEventDestination_eventDestinationName - The name that identifies the event destination.
CreateEventDestination, createEventDestination_matchingEventTypes - An array of event types that determine which events to log. If "ALL"
is used, then Amazon Pinpoint logs every event type.
Request Lenses
createEventDestination_clientToken :: Lens' CreateEventDestination (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
createEventDestination_cloudWatchLogsDestination :: Lens' CreateEventDestination (Maybe CloudWatchLogsDestination) Source #
An object that contains information about an event destination for logging to Amazon CloudWatch logs.
createEventDestination_kinesisFirehoseDestination :: Lens' CreateEventDestination (Maybe KinesisFirehoseDestination) Source #
An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
createEventDestination_snsDestination :: Lens' CreateEventDestination (Maybe SnsDestination) Source #
An object that contains information about an event destination for logging to Amazon SNS.
createEventDestination_configurationSetName :: Lens' CreateEventDestination Text Source #
Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
createEventDestination_eventDestinationName :: Lens' CreateEventDestination Text Source #
The name that identifies the event destination.
createEventDestination_matchingEventTypes :: Lens' CreateEventDestination (NonEmpty EventType) Source #
An array of event types that determine which events to log. If "ALL" is used, then Amazon Pinpoint logs every event type.
Destructuring the Response
data CreateEventDestinationResponse Source #
See: newCreateEventDestinationResponse smart constructor.
Constructors
| CreateEventDestinationResponse' | |
Fields
| |
Instances
newCreateEventDestinationResponse Source #
Create a value of CreateEventDestinationResponse 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:
CreateEventDestinationResponse, createEventDestinationResponse_configurationSetArn - The ARN of the configuration set.
CreateEventDestination, createEventDestinationResponse_configurationSetName - The name of the configuration set.
$sel:eventDestination:CreateEventDestinationResponse', createEventDestinationResponse_eventDestination - The details of the destination where events are logged.
$sel:httpStatus:CreateEventDestinationResponse', createEventDestinationResponse_httpStatus - The response's http status code.
Response Lenses
createEventDestinationResponse_configurationSetArn :: Lens' CreateEventDestinationResponse (Maybe Text) Source #
The ARN of the configuration set.
createEventDestinationResponse_configurationSetName :: Lens' CreateEventDestinationResponse (Maybe Text) Source #
The name of the configuration set.
createEventDestinationResponse_eventDestination :: Lens' CreateEventDestinationResponse (Maybe EventDestination) Source #
The details of the destination where events are logged.
createEventDestinationResponse_httpStatus :: Lens' CreateEventDestinationResponse Int Source #
The response's http status code.