Skip to content

describe_group_membership 

describe_group_membership(
    identity_store_id: IdentityStoreId,
    membership_id: ResourceId,
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
) -> DescribeGroupMembershipResponse

Retrieves membership metadata and attributes from 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.

  • membership_id (ResourceId) –

    The identifier for a GroupMembership in an identity store.

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

Raises:

Source code in docs_src/capo_identitystore/_services/identitystore.py 
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
def describe_group_membership(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    membership_id: "capo_identitystore.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
) -> "capo_identitystore.types.describe_group_membership_response.DescribeGroupMembershipResponse":
    """<p>Retrieves membership metadata and attributes from <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>
        membership_id: <p>The identifier for a <code>GroupMembership</code> in an identity store.</p> <p>You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code> or membership ARN <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</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.describe_group_membership_request.DescribeGroupMembershipRequest]",
    ) -> OperationResponse[
        "capo_identitystore.types.describe_group_membership_response.DescribeGroupMembershipResponse"
    ]:
        import capo_identitystore._operations.aws_identity_store.describe_group_membership

        output, http_response = (
            capo_identitystore._operations.aws_identity_store.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_identitystore.types.describe_group_membership_request.DescribeGroupMembershipRequest = {
        "identity_store_id": identity_store_id,
        "membership_id": membership_id,
    }

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