AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Pinpoint Email UpdateConfigurationSetEventDestination API operation.

Syntax

Update-PINEConfigurationSetEventDestination
-EventDestinationName <String>
-PinpointDestination_ApplicationArn <String>
-ConfigurationSetName <String>
-KinesisFirehoseDestination_DeliveryStreamArn <String>
-CloudWatchDestination_DimensionConfiguration <CloudWatchDimensionConfiguration[]>
-EventDestination_Enabled <Boolean>
-KinesisFirehoseDestination_IamRoleArn <String>
-EventDestination_MatchingEventType <String[]>
-SnsDestination_TopicArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPinpointEmailConfig>

Description

Update the configuration of an event destination for a configuration set. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Parameters

-ClientConfig <AmazonPinpointEmailConfig>
Amazon.PowerShell.Cmdlets.PINE.AmazonPinpointEmailClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudWatchDestination_DimensionConfiguration <CloudWatchDimensionConfiguration[]>
An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEventDestination_CloudWatchDestination_DimensionConfigurations
-ConfigurationSetName <String>
The name of the configuration set that contains the event destination that you want to modify.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventDestination_Enabled <Boolean>
If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EventDestination_MatchingEventType <String[]>
An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEventDestination_MatchingEventTypes
-EventDestinationName <String>
The name of the event destination that you want to modify.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KinesisFirehoseDestination_DeliveryStreamArn <String>
The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEventDestination_KinesisFirehoseDestination_DeliveryStreamArn
-KinesisFirehoseDestination_IamRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEventDestination_KinesisFirehoseDestination_IamRoleArn
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the EventDestinationName parameter. The -PassThru parameter is deprecated, use -Select '^EventDestinationName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PinpointDestination_ApplicationArn <String>
The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEventDestination_PinpointDestination_ApplicationArn
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PinpointEmail.Model.UpdateConfigurationSetEventDestinationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnsDestination_TopicArn <String>
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEventDestination_SnsDestination_TopicArn

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.PinpointEmail.Model.UpdateConfigurationSetEventDestinationResponse
This cmdlet does not generate any output.The service response (type Amazon.PinpointEmail.Model.UpdateConfigurationSetEventDestinationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z