start_automation_job ¶

def start_automation_job(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    automation_group_id: "capo_quicksight.types.automate_id.AutomateId",
    automation_id: "capo_quicksight.types.automate_id.AutomateId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    input_payload: Optional[
        "capo_quicksight.types.sensitive_io_payload.SensitiveIOPayload"
    ] = None,
) -> (
    "capo_quicksight.types.start_automation_job_response.StartAutomationJobResponse"
):
    """<p>Starts a new job for a specified automation. The job runs the automation with the provided input payload.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the automation.</p>
        automation_group_id: <p>The ID of the automation group that contains the automation to run.</p>
        automation_id: <p>The ID of the automation to run.</p>
        input_payload: <p>The input payload for the automation job, provided as a JSON string.</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_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.start_automation_job_request.StartAutomationJobRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.start_automation_job_response.StartAutomationJobResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.start_automation_job

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

    def _redact_input(
        input_: "capo_quicksight.types.start_automation_job_request.StartAutomationJobRequest",
    ) -> dict[str, Any]:
        import capo_quicksight.types.start_automation_job_request

        return capo_quicksight.types.start_automation_job_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("StartAutomationJob", redact_input=_redact_input),
    )
    input_: capo_quicksight.types.start_automation_job_request.StartAutomationJobRequest = {
        "aws_account_id": aws_account_id,
        "automation_group_id": automation_group_id,
        "automation_id": automation_id,
    }
    if input_payload is not None:
        input_["input_payload"] = input_payload

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