Skip to content

create_ingestion

create_ingestion(
    data_set_id: String,
    ingestion_id: IngestionId,
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    ingestion_type: Optional[IngestionType] = None,
) -> CreateIngestionResponse

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.

Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

Parameters:

  • data_set_id (String) –

    The ID of the dataset used in the ingestion.

  • ingestion_id (IngestionId) –

    An ID for the ingestion.

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID.

  • ingestion_type (Optional[IngestionType], default: None ) –

    The type of ingestion that you want to create.

Raises:

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def create_ingestion(
    self,
    data_set_id: "capo_quicksight.types.string.String",
    ingestion_id: "capo_quicksight.types.ingestion_id.IngestionId",
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    ingestion_type: Optional[
        "capo_quicksight.types.ingestion_type.IngestionType"
    ] = None,
) -> "capo_quicksight.types.create_ingestion_response.CreateIngestionResponse":
    """<p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.</p> <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see <a href="http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>

    Args:
        data_set_id: <p>The ID of the dataset used in the ingestion.</p>
        ingestion_id: <p>An ID for the ingestion.</p>
        aws_account_id: <p>The Amazon Web Services account ID.</p>
        ingestion_type: <p>The type of ingestion that you want to create.</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.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</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.create_ingestion_request.CreateIngestionRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.create_ingestion_response.CreateIngestionResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_ingestion

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateIngestion")
    )
    input_: capo_quicksight.types.create_ingestion_request.CreateIngestionRequest = {
        "data_set_id": data_set_id,
        "ingestion_id": ingestion_id,
        "aws_account_id": aws_account_id,
    }
    if ingestion_type is not None:
        input_["ingestion_type"] = ingestion_type

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