Skip to content

create_integration

create_integration(
    integration_name: String128,
    source_arn: String512,
    target_arn: String512,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    description: Optional[IntegrationDescription] = None,
    data_filter: Optional[String2048] = None,
    kms_key_id: Optional[String2048] = None,
    additional_encryption_context: Optional[
        IntegrationAdditionalEncryptionContextMap
    ] = None,
    tags: Optional[IntegrationTagsList] = None,
    integration_config: Optional[IntegrationConfig] = None,
) -> CreateIntegrationResponse

Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the SourceArn and TargetArn.

Parameters:

  • integration_name (String128) –

    A unique name for an integration in Glue.

  • source_arn (String512) –

    The ARN of the source resource for the integration.

  • target_arn (String512) –

    The ARN of the target resource for the integration.

  • description (Optional[IntegrationDescription], default: None ) –

    A description of the integration.

  • data_filter (Optional[String2048], default: None ) –

    Selects source tables for the integration using Maxwell filter syntax.

  • kms_key_id (Optional[String2048], default: None ) –

    The ARN of a KMS key used for encrypting the channel.

  • additional_encryption_context (Optional[IntegrationAdditionalEncryptionContextMap], default: None ) –

    An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if KMSKeyId is provided.

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

    Metadata assigned to the resource consisting of a list of key-value pairs.

  • integration_config (Optional[IntegrationConfig], default: None ) –

    The configuration settings.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def create_integration(
    self,
    integration_name: "capo_glue.types.string128.String128",
    source_arn: "capo_glue.types.string512.String512",
    target_arn: "capo_glue.types.string512.String512",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    description: Optional[
        "capo_glue.types.integration_description.IntegrationDescription"
    ] = None,
    data_filter: Optional["capo_glue.types.string2048.String2048"] = None,
    kms_key_id: Optional["capo_glue.types.string2048.String2048"] = None,
    additional_encryption_context: Optional[
        "capo_glue.types.integration_additional_encryption_context_map.IntegrationAdditionalEncryptionContextMap"
    ] = None,
    tags: Optional[
        "capo_glue.types.integration_tags_list.IntegrationTagsList"
    ] = None,
    integration_config: Optional[
        "capo_glue.types.integration_config.IntegrationConfig"
    ] = None,
) -> "capo_glue.types.create_integration_response.CreateIntegrationResponse":
    """<p>Creates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names (ARNs): the <code>SourceArn</code> and <code>TargetArn</code>.</p>

    Args:
        integration_name: <p>A unique name for an integration in Glue.</p>
        source_arn: <p>The ARN of the source resource for the integration.</p>
        target_arn: <p>The ARN of the target resource for the integration.</p>
        description: <p>A description of the integration.</p>
        data_filter: <p>Selects source tables for the integration using Maxwell filter syntax.</p>
        kms_key_id: <p>The ARN of a KMS key used for encrypting the channel.</p>
        additional_encryption_context: <p>An optional set of non-secret key–value pairs that contains additional contextual information for encryption. This can only be provided if <code>KMSKeyId</code> is provided.</p>
        tags: <p>Metadata assigned to the resource consisting of a list of key-value pairs.</p>
        integration_config: <p>The configuration settings.</p>

    Raises:
        capo_glue.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_glue.errors.conflict_exception.ConflictException: <p>The <code>CreatePartitions</code> API was called on a table that has indexes enabled. </p>
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.integration_conflict_operation_fault.IntegrationConflictOperationFault: <p>The requested operation conflicts with another operation.</p>
        capo_glue.errors.integration_quota_exceeded_fault.IntegrationQuotaExceededFault: <p>The data processed through your integration exceeded your quota.</p>
        capo_glue.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred.</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.kms_key_not_accessible_fault.KMSKeyNotAccessibleFault: <p>The KMS key specified is not accessible.</p>
        capo_glue.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_glue.errors.resource_number_limit_exceeded_exception.ResourceNumberLimitExceededException: <p>A resource numerical limit was exceeded.</p>
        capo_glue.errors.validation_exception.ValidationException: <p>A value could not be validated.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.create_integration_request.CreateIntegrationRequest]",
    ) -> OperationResponse[
        "capo_glue.types.create_integration_response.CreateIntegrationResponse"
    ]:
        import capo_glue._operations.aws_glue.create_integration

        output, http_response = (
            capo_glue._operations.aws_glue.create_integration.create_integration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateIntegration")
    )
    input_: capo_glue.types.create_integration_request.CreateIntegrationRequest = {
        "integration_name": integration_name,
        "source_arn": source_arn,
        "target_arn": target_arn,
    }
    if description is not None:
        input_["description"] = description
    if data_filter is not None:
        input_["data_filter"] = data_filter
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id
    if additional_encryption_context is not None:
        input_["additional_encryption_context"] = additional_encryption_context
    if tags is not None:
        input_["tags"] = tags
    if integration_config is not None:
        input_["integration_config"] = integration_config

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