Skip to content

describe_ingestion 

describe_ingestion(
    aws_account_id: AwsAccountId,
    data_set_id: String,
    ingestion_id: IngestionId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeIngestionResponse

Describes a SPICE ingestion.

Parameters:

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID.

  • data_set_id (String) –

    The ID of the dataset used in the ingestion.

  • ingestion_id (IngestionId) –

    An ID for the ingestion.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py 
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
def describe_ingestion(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    data_set_id: "capo_quicksight.types.string.String",
    ingestion_id: "capo_quicksight.types.ingestion_id.IngestionId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_ingestion_response.DescribeIngestionResponse":
    """<p>Describes a SPICE ingestion.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        data_set_id: <p>The ID of the dataset used in the ingestion.</p>
        ingestion_id: <p>An ID for the ingestion.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_exists_exception.ResourceExistsException: <p>The resource specified already exists. </p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_ingestion_request.DescribeIngestionRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_ingestion_response.DescribeIngestionResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_ingestion

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_ingestion.describe_ingestion(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIngestion")
    )
    input_: capo_quicksight.types.describe_ingestion_request.DescribeIngestionRequest = {
        "aws_account_id": aws_account_id,
        "data_set_id": data_set_id,
        "ingestion_id": ingestion_id,
    }

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