Skip to content

describe_space async

describe_space(
    aws_account_id: AwsAccountId,
    space_id: PublicSpaceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_contributors: Optional[MaxContributors] = None,
) -> DescribeSpaceResponse

Describes an Amazon QuickSight space.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the space.

  • space_id (PublicSpaceId) –

    The ID of the space that you want to describe.

  • max_contributors (Optional[MaxContributors], default: None ) –

    The maximum number of contributors to include in the response.

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_space(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    space_id: "capo_quicksight.types.public_space_id.PublicSpaceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    max_contributors: Optional[
        "capo_quicksight.types.max_contributors.MaxContributors"
    ] = None,
) -> "capo_quicksight.types.describe_space_response.DescribeSpaceResponse":
    """<p>Describes an Amazon QuickSight space.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the space.</p>
        space_id: <p>The ID of the space that you want to describe.</p>
        max_contributors: <p>The maximum number of contributors to include in the response.</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_space_request.DescribeSpaceRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.describe_space_response.DescribeSpaceResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_space

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

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

        return capo_quicksight.types.describe_space_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeSpace", redact_output=_redact_output),
    )
    input_: capo_quicksight.types.describe_space_request.DescribeSpaceRequest = {
        "aws_account_id": aws_account_id,
        "space_id": space_id,
    }
    if max_contributors is not None:
        input_["max_contributors"] = max_contributors

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