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.

Update-CCS2CampaignChannelSubtypeConfig Cmdlet

AmazonConnectCampaignServiceV2
Available in AWS.Tools.ConnectCampaignsV2, AWSPowerShell.NetCore and AWSPowerShell

Synopsis

Calls the AmazonConnectCampaignServiceV2 UpdateCampaignChannelSubtypeConfig API operation.

Syntax

Update-CCS2CampaignChannelSubtypeConfig
-Id <String>
-ChannelSubtypeConfig_Email_OutboundMode_Agentless <AgentlessConfig>
-ChannelSubtypeConfig_Sms_OutboundMode_Agentless <AgentlessConfig>
-ChannelSubtypeConfig_Telephony_OutboundMode_Agentless <AgentlessConfig>
-AnswerMachineDetectionConfig_AwaitAnswerMachinePrompt <Boolean>
-Predictive_BandwidthAllocation <Double>
-Progressive_BandwidthAllocation <Double>
-Email_Capacity <Double>
-Sms_Capacity <Double>
-Telephony_Capacity <Double>
-DefaultOutboundConfig_ConnectContactFlowId <String>
-Telephony_ConnectQueueId <String>
-DefaultOutboundConfig_ConnectSourceEmailAddress <String>
-DefaultOutboundConfig_ConnectSourcePhoneNumber <String>
-DefaultOutboundConfig_ConnectSourcePhoneNumberArn <String>
-AnswerMachineDetectionConfig_EnableAnswerMachineDetection <Boolean>
-DefaultOutboundConfig_SourceEmailAddressDisplayName <String>
-ChannelSubtypeConfig_Email_DefaultOutboundConfig_WisdomTemplateArn <String>
-ChannelSubtypeConfig_Sms_DefaultOutboundConfig_WisdomTemplateArn <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonConnectCampaignsV2Config>

Description

Updates the channel subtype config of a campaign. This API is idempotent.

Parameters

-AnswerMachineDetectionConfig_AwaitAnswerMachinePrompt <Boolean>

Enable or disable await answer machine prompt

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_DefaultOutboundConfig_AnswerMachineDetectionConfig_AwaitAnswerMachinePrompt

-AnswerMachineDetectionConfig_EnableAnswerMachineDetection <Boolean>

Enable or disable answering machine detection

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_DefaultOutboundConfig_AnswerMachineDetectionConfig_EnableAnswerMachineDetection

-ChannelSubtypeConfig_Email_DefaultOutboundConfig_WisdomTemplateArn <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-ChannelSubtypeConfig_Email_OutboundMode_Agentless <AgentlessConfig>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-ChannelSubtypeConfig_Sms_DefaultOutboundConfig_WisdomTemplateArn <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-ChannelSubtypeConfig_Sms_OutboundMode_Agentless <AgentlessConfig>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-ChannelSubtypeConfig_Telephony_OutboundMode_Agentless <AgentlessConfig>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-ClientConfig <AmazonConnectCampaignsV2Config>

Amazon.PowerShell.Cmdlets.CCS2.AmazonConnectCampaignsV2ClientCmdlet.ClientConfig

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-DefaultOutboundConfig_ConnectContactFlowId <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_DefaultOutboundConfig_ConnectContactFlowId

-DefaultOutboundConfig_ConnectSourceEmailAddress <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Email_DefaultOutboundConfig_ConnectSourceEmailAddress

-DefaultOutboundConfig_ConnectSourcePhoneNumber <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_DefaultOutboundConfig_ConnectSourcePhoneNumber

-DefaultOutboundConfig_ConnectSourcePhoneNumberArn <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Sms_DefaultOutboundConfig_ConnectSourcePhoneNumberArn

-DefaultOutboundConfig_SourceEmailAddressDisplayName <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Email_DefaultOutboundConfig_SourceEmailAddressDisplayName

-Email_Capacity <Double>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Email_Capacity

-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)

-Id <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	True
Position?	1
Accept pipeline input?	True (ByValue, ByPropertyName)

-Predictive_BandwidthAllocation <Double>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_OutboundMode_Predictive_BandwidthAllocation

-Progressive_BandwidthAllocation <Double>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_OutboundMode_Progressive_BandwidthAllocation

-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.ConnectCampaignsV2.Model.UpdateCampaignChannelSubtypeConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)

-Sms_Capacity <Double>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Sms_Capacity

-Telephony_Capacity <Double>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_Capacity

-Telephony_ConnectQueueId <String>

The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.

Required?	False
Position?	Named
Accept pipeline input?	True (ByPropertyName)
Aliases	ChannelSubtypeConfig_Telephony_ConnectQueueId

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)
Aliases	AK

-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)
Aliases	AWSProfilesLocation, 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)
Aliases	StoredCredentials, 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)
Aliases	RegionToCall

-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)
Aliases	SK, 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)
Aliases	ST

Outputs

None or Amazon.ConnectCampaignsV2.Model.UpdateCampaignChannelSubtypeConfigResponse

This cmdlet does not generate any output.The service response (type Amazon.ConnectCampaignsV2.Model.UpdateCampaignChannelSubtypeConfigResponse) be returned by specifying '-Select *'.

Supported Version

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

Link to this page Did this page help you? Yes No Tell us about it...