get_group_membership_id ¶

get_group_membership_id(
    identity_store_id: IdentityStoreId,
    group_id: ResourceId,
    member_id: MemberId,
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
) -> GetGroupMembershipIdResponse

Retrieves the MembershipId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Parameters:

identity_store_id (IdentityStoreId) –

The globally unique identifier for the identity store.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
group_id (ResourceId) –

The identifier for a group in the identity store.

You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
member_id (MemberId) –

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure with an internal server.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_identitystore/_services/identitystore.py

def get_group_membership_id(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    group_id: "capo_identitystore.types.resource_id.ResourceId",
    member_id: "capo_identitystore.types.member_id.MemberId",
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
) -> "capo_identitystore.types.get_group_membership_id_response.GetGroupMembershipIdResponse":
    """<p>Retrieves the <code>MembershipId</code> in an identity store.</p> <note> <p>If you have access to a member account, you can use this API operation from the member account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts">Limiting access to the identity store from member accounts</a> in the <i> IAM Identity Center User Guide</i>.</p> </note>

    Args:
        identity_store_id: <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
        group_id: <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
        member_id: <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>

    Raises:
        capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
        capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_identitystore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_identitystore.types.get_group_membership_id_request.GetGroupMembershipIdRequest]",
    ) -> OperationResponse[
        "capo_identitystore.types.get_group_membership_id_response.GetGroupMembershipIdResponse"
    ]:
        import capo_identitystore._operations.aws_identity_store.get_group_membership_id

        output, http_response = (
            capo_identitystore._operations.aws_identity_store.get_group_membership_id.get_group_membership_id(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetGroupMembershipId")
    )
    input_: capo_identitystore.types.get_group_membership_id_request.GetGroupMembershipIdRequest = {
        "identity_store_id": identity_store_id,
        "group_id": group_id,
        "member_id": member_id,
    }

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