describe_brand ¶

describe_brand(
    aws_account_id: AwsAccountId,
    brand_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    version_id: Optional[ShortRestrictiveResourceId] = None,
) -> DescribeBrandResponse

Describes a brand.

Parameters:

aws_account_id (AwsAccountId) –

The ID of the Amazon Web Services account that owns the brand.
brand_id (ShortRestrictiveResourceId) –

The ID of the Quick brand.
version_id (Optional[ShortRestrictiveResourceId], default: None ) –

The ID of the specific version. The default value is the latest version.

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

Updating or deleting a resource can cause an inconsistent state.
InternalServerException –

An internal service exception.
InvalidRequestException –

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.
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/quick_sight.py

def describe_brand(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    brand_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    version_id: Optional[
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    ] = None,
) -> "capo_quicksight.types.describe_brand_response.DescribeBrandResponse":
    """<p>Describes a brand.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that owns the brand.</p>
        brand_id: <p>The ID of the Quick brand.</p>
        version_id: <p>The ID of the specific version. The default value is the latest version.</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.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_quicksight.errors.internal_server_exception.InternalServerException: <p>An internal service exception.</p>
        capo_quicksight.errors.invalid_request_exception.InvalidRequestException: <p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</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_brand_request.DescribeBrandRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_brand_response.DescribeBrandResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_brand

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeBrand")
    )
    input_: capo_quicksight.types.describe_brand_request.DescribeBrandRequest = {
        "aws_account_id": aws_account_id,
        "brand_id": brand_id,
    }
    if version_id is not None:
        input_["version_id"] = version_id

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