- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateDataIntegrationAssociationCommand
Creates and persists a DataIntegrationAssociation resource.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppIntegrationsClient, CreateDataIntegrationAssociationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import
// const { AppIntegrationsClient, CreateDataIntegrationAssociationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import
const client = new AppIntegrationsClient(config);
const input = { // CreateDataIntegrationAssociationRequest
DataIntegrationIdentifier: "STRING_VALUE", // required
ClientId: "STRING_VALUE",
ObjectConfiguration: { // ObjectConfiguration
"<keys>": { // FieldsMap
"<keys>": [ // FieldsList
"STRING_VALUE",
],
},
},
DestinationURI: "STRING_VALUE",
ClientAssociationMetadata: { // ClientAssociationMetadata
"<keys>": "STRING_VALUE",
},
ClientToken: "STRING_VALUE",
ExecutionConfiguration: { // ExecutionConfiguration
ExecutionMode: "ON_DEMAND" || "SCHEDULED", // required
OnDemandConfiguration: { // OnDemandConfiguration
StartTime: "STRING_VALUE", // required
EndTime: "STRING_VALUE",
},
ScheduleConfiguration: { // ScheduleConfiguration
FirstExecutionFrom: "STRING_VALUE",
Object: "STRING_VALUE",
ScheduleExpression: "STRING_VALUE", // required
},
},
};
const command = new CreateDataIntegrationAssociationCommand(input);
const response = await client.send(command);
// { // CreateDataIntegrationAssociationResponse
// DataIntegrationAssociationId: "STRING_VALUE",
// DataIntegrationArn: "STRING_VALUE",
// };
CreateDataIntegrationAssociationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DataIntegrationIdentifier Required | string | undefined | A unique identifier for the DataIntegration. |
ClientAssociationMetadata | Record<string, string> | undefined | The mapping of metadata to be extracted from the data. |
ClientId | string | undefined | The identifier for the client that is associated with the DataIntegration association. |
ClientToken | string | undefined | A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs . |
DestinationURI | string | undefined | The URI of the data destination. |
ExecutionConfiguration | ExecutionConfiguration | undefined | The configuration for how the files should be pulled from the source. |
ObjectConfiguration | Record<string, Record<string, string[]> | undefined | The configuration for what data should be pulled from the source. |
CreateDataIntegrationAssociationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DataIntegrationArn | string | undefined | The Amazon Resource Name (ARN) for the DataIntegration. |
DataIntegrationAssociationId | string | undefined | A unique identifier. for the DataIntegrationAssociation. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
InternalServiceError | server | Request processing failed due to an error or failure with the service. |
InvalidRequestException | client | The request is not valid. |
ResourceNotFoundException | client | The specified resource was not found. |
ResourceQuotaExceededException | client | The allowed quota for the resource has been exceeded. |
ThrottlingException | client | The throttling limit has been exceeded. |
AppIntegrationsServiceException | Base exception class for all service exceptions from AppIntegrations service. |