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 Connect Customer Profiles PutIntegration API operation.

Syntax

Write-CPFIntegration
-Uri <String>
-S3_BucketName <String>
-S3_BucketPrefix <String>
-SourceFlowConfig_ConnectorProfileName <String>
-SourceFlowConfig_ConnectorType <SourceConnectorType>
-Scheduled_DataPullMode <DataPullMode>
-IncrementalPullConfig_DatetimeTypeFieldName <String>
-FlowDefinition_Description <String>
-DomainName <String>
-Salesforce_EnableDynamicFieldUpdate <Boolean>
-Scheduled_FirstExecutionFrom <DateTime>
-FlowDefinition_FlowName <String>
-Salesforce_IncludeDeletedRecord <Boolean>
-FlowDefinition_KmsArn <String>
-Marketo_Object <String>
-Salesforce_Object <String>
-ServiceNow_Object <String>
-Zendesk_Object <String>
-ObjectTypeName <String>
-ObjectTypeNames <Hashtable>
-Scheduled_ScheduleEndTime <DateTime>
-Scheduled_ScheduleExpression <String>
-Scheduled_ScheduleOffset <Int64>
-Scheduled_ScheduleStartTime <DateTime>
-Tag <Hashtable>
-FlowDefinition_Task <Task[]>
-Scheduled_Timezone <String>
-TriggerConfig_TriggerType <TriggerType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCustomerProfilesConfig>

Description

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. An integration can belong to only one domain. To add or remove tags on an existing Integration, see TagResource / UntagResource.

Parameters

-ClientConfig <AmazonCustomerProfilesConfig>
Amazon.PowerShell.Cmdlets.CPF.AmazonCustomerProfilesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DomainName <String>
The unique name of the domain.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FlowDefinition_Description <String>
A description of the flow you want to create.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FlowDefinition_FlowName <String>
The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FlowDefinition_KmsArn <String>
The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FlowDefinition_Task <Task[]>
A list of tasks that Customer Profiles performs while transferring the data in the flow run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_Tasks
-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)
-IncrementalPullConfig_DatetimeTypeFieldName <String>
A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_IncrementalPullConfig_DatetimeTypeFieldName
-Marketo_Object <String>
The object specified in the Marketo flow source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_Marketo_Object
-ObjectTypeName <String>
The name of the profile object type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ObjectTypeNames <Hashtable>
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Uri parameter. The -PassThru parameter is deprecated, use -Select '^Uri' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3_BucketName <String>
The Amazon S3 bucket name where the source files are stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_S3_BucketName
-S3_BucketPrefix <String>
The object key for the Amazon S3 bucket in which the source files are stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_S3_BucketPrefix
-Salesforce_EnableDynamicFieldUpdate <Boolean>
The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_Salesforce_EnableDynamicFieldUpdate
-Salesforce_IncludeDeletedRecord <Boolean>
Indicates whether Amazon AppFlow includes deleted files in the flow run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_Salesforce_IncludeDeletedRecords
-Salesforce_Object <String>
The object specified in the Salesforce flow source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_Salesforce_Object
-Scheduled_DataPullMode <DataPullMode>
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_DataPullMode
-Scheduled_FirstExecutionFrom <DateTime>
Specifies the date range for the records to import from the connector in the first flow run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_FirstExecutionFrom
-Scheduled_ScheduleEndTime <DateTime>
Specifies the scheduled end time for a scheduled-trigger flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_ScheduleEndTime
-Scheduled_ScheduleExpression <String>
The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_ScheduleExpression
-Scheduled_ScheduleOffset <Int64>
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_ScheduleOffset
-Scheduled_ScheduleStartTime <DateTime>
Specifies the scheduled start time for a scheduled-trigger flow.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_ScheduleStartTime
-Scheduled_Timezone <String>
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerProperties_Scheduled_Timezone
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.PutIntegrationResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.PutIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceNow_Object <String>
The object specified in the ServiceNow flow source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_ServiceNow_Object
-SourceFlowConfig_ConnectorProfileName <String>
The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_ConnectorProfileName
-SourceFlowConfig_ConnectorType <SourceConnectorType>
The type of connector, such as Salesforce, Marketo, and so on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_ConnectorType
-Tag <Hashtable>
The tags used to organize, track, or control access for this resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TriggerConfig_TriggerType <TriggerType>
Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_TriggerConfig_TriggerType
-Uri <String>
The URI of the S3 bucket or any other type of data source.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Zendesk_Object <String>
The object specified in the Zendesk flow source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFlowDefinition_SourceFlowConfig_SourceConnectorProperties_Zendesk_Object

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

Amazon.CustomerProfiles.Model.PutIntegrationResponse
This cmdlet returns an Amazon.CustomerProfiles.Model.PutIntegrationResponse object containing multiple properties. The object can also 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