Skip to content

create_integration_association

create_integration_association(
    instance_id: InstanceId,
    integration_type: IntegrationType,
    integration_arn: ARN,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    source_application_url: Optional[URI] = None,
    source_application_name: Optional[SourceApplicationName] = None,
    source_type: Optional[SourceType] = None,
    tags: Optional[TagMap] = None,
) -> CreateIntegrationAssociationResponse

Creates an Amazon Web Services resource association with an Connect Customer instance.

Parameters:

  • instance_id (InstanceId) –

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • integration_type (IntegrationType) –

    The type of information to be ingested.

  • integration_arn (ARN) –

    The Amazon Resource Name (ARN) of the integration.

    When integrating with Amazon Web Services End User Messaging, the Connect Customer and Amazon Web Services End User Messaging instances must be in the same account.

  • source_application_url (Optional[URI], default: None ) –

    The URL for the external application. This field is only required for the EVENT integration type.

  • source_application_name (Optional[SourceApplicationName], default: None ) –

    The name of the external application. This field is only required for the EVENT integration type.

  • source_type (Optional[SourceType], default: None ) –

    The type of the data source. This field is only required for the EVENT integration type.

  • tags (Optional[TagMap], default: None ) –

    The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def create_integration_association(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    integration_type: "capo_connect.types.integration_type.IntegrationType",
    integration_arn: "capo_connect.types.arn.ARN",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    source_application_url: Optional["capo_connect.types.uri.URI"] = None,
    source_application_name: Optional[
        "capo_connect.types.source_application_name.SourceApplicationName"
    ] = None,
    source_type: Optional["capo_connect.types.source_type.SourceType"] = None,
    tags: Optional["capo_connect.types.tag_map.TagMap"] = None,
) -> "capo_connect.types.create_integration_association_response.CreateIntegrationAssociationResponse":
    """<p>Creates an Amazon Web Services resource association with an Connect Customer instance.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        integration_type: <p>The type of information to be ingested.</p>
        integration_arn: <p>The Amazon Resource Name (ARN) of the integration.</p> <note> <p>When integrating with Amazon Web Services End User Messaging, the Connect Customer and Amazon Web Services End User Messaging instances must be in the same account.</p> </note>
        source_application_url: <p>The URL for the external application. This field is only required for the EVENT integration type.</p>
        source_application_name: <p>The name of the external application. This field is only required for the EVENT integration type.</p>
        source_type: <p>The type of the data source. This field is only required for the EVENT integration type.</p>
        tags: <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>

    Raises:
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.create_integration_association_request.CreateIntegrationAssociationRequest]",
    ) -> OperationResponse[
        "capo_connect.types.create_integration_association_response.CreateIntegrationAssociationResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.create_integration_association

        output, http_response = (
            capo_connect._operations.amazon_connect_service.create_integration_association.create_integration_association(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateIntegrationAssociation")
    )
    input_: capo_connect.types.create_integration_association_request.CreateIntegrationAssociationRequest = {
        "instance_id": instance_id,
        "integration_type": integration_type,
        "integration_arn": integration_arn,
    }
    if source_application_url is not None:
        input_["source_application_url"] = source_application_url
    if source_application_name is not None:
        input_["source_application_name"] = source_application_name
    if source_type is not None:
        input_["source_type"] = source_type
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output