Skip to content

DescribeGroupResponse

Source code in docs_src/capo_identitystore/types/describe_group_response.py
class DescribeGroupResponse(TypedDict, closed=True):
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId"
    """<p>The globally unique identifier for the identity store.</p>"""
    group_id: "capo_identitystore.types.resource_id.ResourceId"
    """<p>The identifier for a group in the identity store.</p>"""
    group_arn: "capo_identitystore.types.resource_arn.ResourceArn"
    """<p>The Amazon Resource Name (ARN) of the group in the identity store. For example, <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>"""
    revision: "capo_identitystore.types.resource_revision.ResourceRevision"
    """<p>The current revision of the group in the identity store. This value changes each time the group is modified.</p>"""
    display_name: NotRequired[
        "capo_identitystore.types.group_display_name.GroupDisplayName"
    ]
    """<p>The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.</p>"""
    external_ids: NotRequired["capo_identitystore.types.external_ids.ExternalIds"]
    """<p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>"""
    description: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing a description of the group.</p>"""
    created_at: NotRequired["capo_identitystore.types.date_type.DateType"]
    """<p>The date and time the group was created.</p>"""
    updated_at: NotRequired["capo_identitystore.types.date_type.DateType"]
    """<p>The date and time the group was last updated.</p>"""
    created_by: NotRequired["capo_identitystore.types.string_type.StringType"]
    """<p>The identifier of the user or system that created the group.</p>"""
    updated_by: NotRequired["capo_identitystore.types.string_type.StringType"]
    """<p>The identifier of the user or system that last updated the group.</p>"""

created_at instance-attribute

created_at: NotRequired[DateType]

The date and time the group was created.

created_by instance-attribute

created_by: NotRequired[StringType]

The identifier of the user or system that created the group.

description instance-attribute

description: NotRequired[SensitiveStringType]

A string containing a description of the group.

display_name instance-attribute

display_name: NotRequired[GroupDisplayName]

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

external_ids instance-attribute

external_ids: NotRequired[ExternalIds]

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

group_arn instance-attribute

group_arn: ResourceArn

The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

group_id instance-attribute

group_id: ResourceId

The identifier for a group in the identity store.

identity_store_id instance-attribute

identity_store_id: IdentityStoreId

The globally unique identifier for the identity store.

revision instance-attribute

revision: ResourceRevision

The current revision of the group in the identity store. This value changes each time the group is modified.

updated_at instance-attribute

updated_at: NotRequired[DateType]

The date and time the group was last updated.

updated_by instance-attribute

updated_by: NotRequired[StringType]

The identifier of the user or system that last updated the group.