Skip to content

create_ingestion async 

create_ingestion(
    data_set_id: String,
    ingestion_id: IngestionId,
    aws_account_id: AwsAccountId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = 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/async_quick_sight.py 
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
async 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[AsyncQuickSightClientConfig] = 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.create_ingestion_request.CreateIngestionRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.create_ingestion_response.CreateIngestionResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_ingestion

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.create_ingestion.async_create_ingestion(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output