get_flow_metadata `async` ¶

get_flow_metadata(
    aws_account_id: AccountId,
    flow_id: FlowId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> GetFlowMetadataOutput

Retrieves the metadata of a flow, not including its definition specifying the steps.

Parameters:

aws_account_id (AccountId) –

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

The unique identifier of the flow.

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.
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 get_flow_metadata(
    self,
    aws_account_id: "capo_quicksight.types.account_id.AccountId",
    flow_id: "capo_quicksight.types.flow_id.FlowId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
) -> "capo_quicksight.types.get_flow_metadata_output.GetFlowMetadataOutput":
    """<p>Retrieves the metadata of a flow, not including its definition specifying the steps.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.</p>
        flow_id: <p>The unique identifier of the flow.</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.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.get_flow_metadata_input.GetFlowMetadataInput]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.get_flow_metadata_output.GetFlowMetadataOutput"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.get_flow_metadata

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetFlowMetadata")
    )
    input_: capo_quicksight.types.get_flow_metadata_input.GetFlowMetadataInput = {
        "aws_account_id": aws_account_id,
        "flow_id": flow_id,
    }

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

get_flow_metadata async ¶

get_flow_metadata `async` ¶