describe_automation_job ¶

def describe_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",
    job_id: "capo_quicksight.types.automate_id.AutomateId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    include_input_payload: Optional["capo_quicksight.types.boolean.Boolean"] = None,
    include_output_payload: Optional[
        "capo_quicksight.types.boolean.Boolean"
    ] = None,
) -> "capo_quicksight.types.describe_automation_job_response.DescribeAutomationJobResponse":
    """<p>Retrieves the status and details of a specified automation job, including its status and outputs.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the automation job.</p>
        automation_group_id: <p>The ID of the automation group that contains the automation.</p>
        automation_id: <p>The ID of the automation that the job belongs to.</p>
        include_input_payload: <p>A Boolean value that indicates whether to include the input payload in the response. If set to <code>true</code>, the input payload will be included. If set to <code>false</code>, the input payload will be returned as <code>null</code>.</p>
        include_output_payload: <p>A Boolean value that indicates whether to include the output payload in the response. If set to <code>true</code>, the output payload will be included. If set to <code>false</code>, the output payload will be returned as <code>null</code>.</p>
        job_id: <p>The ID of the automation job to describe.</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_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_automation_job_request.DescribeAutomationJobRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_automation_job_response.DescribeAutomationJobResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_automation_job

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

    def _redact_output(
        output: "capo_quicksight.types.describe_automation_job_response.DescribeAutomationJobResponse",
    ) -> dict[str, Any]:
        import capo_quicksight.types.describe_automation_job_response

        return (
            capo_quicksight.types.describe_automation_job_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeAutomationJob", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.describe_automation_job_request.DescribeAutomationJobRequest = {
        "aws_account_id": aws_account_id,
        "automation_group_id": automation_group_id,
        "automation_id": automation_id,
        "job_id": job_id,
    }
    if include_input_payload is not None:
        input_["include_input_payload"] = include_input_payload
    if include_output_payload is not None:
        input_["include_output_payload"] = include_output_payload

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