Skip to content

describe_integrations

describe_integrations(
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    integration_identifier: Optional[String128] = None,
    marker: Optional[String128] = None,
    max_records: Optional[IntegrationInteger] = None,
    filters: Optional[IntegrationFilterList] = None,
) -> DescribeIntegrationsResponse

The API is used to retrieve a list of integrations.

Parameters:

  • integration_identifier (Optional[String128], default: None ) –

    The Amazon Resource Name (ARN) for the integration.

  • marker (Optional[String128], default: None ) –

    A value that indicates the starting point for the next set of response records in a subsequent request.

  • max_records (Optional[IntegrationInteger], default: None ) –

    The total number of items to return in the output.

  • filters (Optional[IntegrationFilterList], default: None ) –

    A list of key and values, to filter down the results. Supported keys are "Status", "IntegrationName", and "SourceArn". IntegrationName is limited to only one value.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def describe_integrations(
    self,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    integration_identifier: Optional["capo_glue.types.string128.String128"] = None,
    marker: Optional["capo_glue.types.string128.String128"] = None,
    max_records: Optional[
        "capo_glue.types.integration_integer.IntegrationInteger"
    ] = None,
    filters: Optional[
        "capo_glue.types.integration_filter_list.IntegrationFilterList"
    ] = None,
) -> "capo_glue.types.describe_integrations_response.DescribeIntegrationsResponse":
    """<p>The API is used to retrieve a list of integrations.</p>

    Args:
        integration_identifier: <p>The Amazon Resource Name (ARN) for the integration.</p>
        marker: <p>A value that indicates the starting point for the next set of response records in a subsequent request.</p>
        max_records: <p>The total number of items to return in the output.</p>
        filters: <p>A list of key and values, to filter down the results. Supported keys are "Status", "IntegrationName", and "SourceArn". IntegrationName is limited to only one value.</p>

    Raises:
        capo_glue.errors.access_denied_exception.AccessDeniedException: <p>Access to a resource was denied.</p>
        capo_glue.errors.entity_not_found_exception.EntityNotFoundException: <p>A specified entity does not exist</p>
        capo_glue.errors.integration_not_found_fault.IntegrationNotFoundFault: <p>The specified integration could not be found.</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.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.describe_integrations_request.DescribeIntegrationsRequest]",
    ) -> OperationResponse[
        "capo_glue.types.describe_integrations_response.DescribeIntegrationsResponse"
    ]:
        import capo_glue._operations.aws_glue.describe_integrations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIntegrations")
    )
    input_: capo_glue.types.describe_integrations_request.DescribeIntegrationsRequest = {}
    if integration_identifier is not None:
        input_["integration_identifier"] = integration_identifier
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records
    if filters is not None:
        input_["filters"] = filters

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