describe_flow `async` ¶

describe_flow(
    aws_account_id: AccountId,
    flow_id: FlowId,
    publish_state: FlowPublishState,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> DescribeFlowResponse

Returns the full details of a flow for the latest version of the requested publish state.

Parameters:

aws_account_id (AccountId) –

The ID of the Amazon Web Services account that contains the flow that you are describing.
flow_id (FlowId) –

The unique identifier of the flow.
publish_state (FlowPublishState) –

The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

Raises:

AccessDeniedException –

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.
InternalFailureException –

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py

async def describe_flow(
    self,
    aws_account_id: "capo_quicksight.types.account_id.AccountId",
    flow_id: "capo_quicksight.types.flow_id.FlowId",
    publish_state: "capo_quicksight.types.flow_publish_state.FlowPublishState",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_flow_response.DescribeFlowResponse":
    """<p>Returns the full details of a flow for the latest version of the requested publish state.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the flow that you are describing.</p>
        flow_id: <p>The unique identifier of the flow.</p>
        publish_state: <p>The publish state of the flow version to describe. Valid values are <code>DRAFT</code>, <code>PUBLISHED</code>, or <code>PENDING_APPROVAL</code>.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.describe_flow_request.DescribeFlowRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_flow_response.DescribeFlowResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_flow

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.describe_flow.async_describe_flow(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

        return capo_quicksight.types.describe_flow_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeFlow", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.describe_flow_request.DescribeFlowRequest = {
        "aws_account_id": aws_account_id,
        "flow_id": flow_id,
        "publish_state": publish_state,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_flow async ¶

describe_flow `async` ¶