Skip to content

update_topic_permissions

update_topic_permissions(
    aws_account_id: AwsAccountId,
    topic_id: TopicId,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    grant_permissions: Optional[UpdateResourcePermissionList] = None,
    revoke_permissions: Optional[UpdateResourcePermissionList] = None,
) -> UpdateTopicPermissionsResponse

Updates the permissions of a topic.

Parameters:

  • aws_account_id (AwsAccountId) –

    The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.

  • topic_id (TopicId) –

    The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

  • grant_permissions (Optional[UpdateResourcePermissionList], default: None ) –

    The resource permissions that you want to grant to the topic.

  • revoke_permissions (Optional[UpdateResourcePermissionList], default: None ) –

    The resource permissions that you want to revoke from the topic.

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.

  • InternalFailureException –

    An internal failure occurred.

  • InvalidParameterValueException –

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

  • LimitExceededException –

    A limit is exceeded.

  • 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/quick_sight.py
def update_topic_permissions(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    topic_id: "capo_quicksight.types.topic_id.TopicId",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    grant_permissions: Optional[
        "capo_quicksight.types.update_resource_permission_list.UpdateResourcePermissionList"
    ] = None,
    revoke_permissions: Optional[
        "capo_quicksight.types.update_resource_permission_list.UpdateResourcePermissionList"
    ] = None,
) -> "capo_quicksight.types.update_topic_permissions_response.UpdateTopicPermissionsResponse":
    """<p>Updates the permissions of a topic.</p>

    Args:
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.</p>
        topic_id: <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
        grant_permissions: <p>The resource permissions that you want to grant to the topic.</p>
        revoke_permissions: <p>The resource permissions that you want to revoke from the topic.</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_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_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.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.update_topic_permissions_request.UpdateTopicPermissionsRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.update_topic_permissions_response.UpdateTopicPermissionsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.update_topic_permissions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateTopicPermissions")
    )
    input_: capo_quicksight.types.update_topic_permissions_request.UpdateTopicPermissionsRequest = {
        "aws_account_id": aws_account_id,
        "topic_id": topic_id,
    }
    if grant_permissions is not None:
        input_["grant_permissions"] = grant_permissions
    if revoke_permissions is not None:
        input_["revoke_permissions"] = revoke_permissions

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