describe_group_membership ¶

describe_group_membership(
    member_name: GroupMemberName,
    group_name: GroupName,
    aws_account_id: AwsAccountId,
    namespace: Namespace,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeGroupMembershipResponse

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

Parameters:

member_name (GroupMemberName) –

The user name of the user that you want to search for.
group_name (GroupName) –

The name of the group that you want to search.
aws_account_id (AwsAccountId) –

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
namespace (Namespace) –

The namespace that includes the group you are searching within.

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

One or more preconditions aren't met.
ResourceNotFoundException –

One or more resources can't be found.
ResourceUnavailableException –

This resource is currently unavailable.
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_group_membership(
    self,
    member_name: "capo_quicksight.types.group_member_name.GroupMemberName",
    group_name: "capo_quicksight.types.group_name.GroupName",
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    namespace: "capo_quicksight.types.namespace.Namespace",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_group_membership_response.DescribeGroupMembershipResponse":
    """<p>Use the <code>DescribeGroupMembership</code> operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated <code>GroupMember</code> object is returned.</p>

    Args:
        member_name: <p>The user name of the user that you want to search for.</p>
        group_name: <p>The name of the group that you want to search.</p>
        aws_account_id: <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
        namespace: <p>The namespace that includes the group you are searching within.</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.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.resource_unavailable_exception.ResourceUnavailableException: <p>This resource is currently unavailable.</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_group_membership_request.DescribeGroupMembershipRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_group_membership_response.DescribeGroupMembershipResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_group_membership

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeGroupMembership")
    )
    input_: capo_quicksight.types.describe_group_membership_request.DescribeGroupMembershipRequest = {
        "member_name": member_name,
        "group_name": group_name,
        "aws_account_id": aws_account_id,
        "namespace": namespace,
    }

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