Skip to content

update_theme async

update_theme(
    aws_account_id: AwsAccountId,
    theme_id: ShortRestrictiveResourceId,
    base_theme_id: ShortRestrictiveResourceId,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    name: Optional[ThemeName] = None,
    version_description: Optional[VersionDescription] = None,
    configuration: Optional[ThemeConfiguration] = None,
) -> UpdateThemeResponse

Updates a theme.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the theme that you're updating.

  • theme_id (ShortRestrictiveResourceId) –

    The ID for the theme.

  • name (Optional[ThemeName], default: None ) –

    The name for the theme.

  • base_theme_id (ShortRestrictiveResourceId) –

    The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.

  • version_description (Optional[VersionDescription], default: None ) –

    A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

  • configuration (Optional[ThemeConfiguration], default: None ) –

    The theme configuration, which contains the theme display properties.

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.

  • LimitExceededException –

    A limit is exceeded.

  • ResourceExistsException –

    The resource specified already exists.

  • ResourceNotFoundException –

    One or more resources can't be found.

  • ThrottlingException –

    Access is throttled.

  • UnsupportedUserEditionException –

    This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

  • 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 update_theme(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    theme_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    base_theme_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    name: Optional["capo_quicksight.types.theme_name.ThemeName"] = None,
    version_description: Optional[
        "capo_quicksight.types.version_description.VersionDescription"
    ] = None,
    configuration: Optional[
        "capo_quicksight.types.theme_configuration.ThemeConfiguration"
    ] = None,
) -> "capo_quicksight.types.update_theme_response.UpdateThemeResponse":
    """<p>Updates a theme.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
        theme_id: <p>The ID for the theme.</p>
        name: <p>The name for the theme.</p>
        base_theme_id: <p>The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from. All themes initially inherit from a default Quick Sight theme.</p>
        version_description: <p>A description of the theme version that you're updating Every time that you call <code>UpdateTheme</code>, you create a new version of the theme. Each version of the theme maintains a description of the version in <code>VersionDescription</code>.</p>
        configuration: <p>The theme configuration, which contains the theme display properties.</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.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.resource_exists_exception.ResourceExistsException: <p>The resource specified already exists. </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.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.update_theme_request.UpdateThemeRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.update_theme_response.UpdateThemeResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_theme

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateTheme")
    )
    input_: capo_quicksight.types.update_theme_request.UpdateThemeRequest = {
        "aws_account_id": aws_account_id,
        "theme_id": theme_id,
        "base_theme_id": base_theme_id,
    }
    if name is not None:
        input_["name"] = name
    if version_description is not None:
        input_["version_description"] = version_description
    if configuration is not None:
        input_["configuration"] = configuration

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