Skip to content

IdentityCenterOptionsInput

Used by
Source code in docs_src/capo_opensearch/types/identity_center_options_input.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class IdentityCenterOptionsInput(TypedDict, closed=True):
    enabled_api_access: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.</p>"""
    identity_center_instance_arn: NotRequired[
        "capo_opensearch.types.identity_center_instance_arn.IdentityCenterInstanceARN"
    ]
    """<p>The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.</p>"""
    identity_center_instance_region: NotRequired["capo_opensearch.types.region.Region"]
    """<p>The Region of the IAM Identity Center instance.</p>"""
    subject_key: NotRequired[
        "capo_opensearch.types.subject_key_id_c_option.SubjectKeyIdCOption"
    ]
    """<p>Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.</p>"""
    roles_key: NotRequired[
        "capo_opensearch.types.roles_key_id_c_option.RolesKeyIdCOption"
    ]
    """<p>Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.</p>"""

enabled_api_access instance-attribute 

enabled_api_access: NotRequired[Boolean]

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.

identity_center_instance_arn instance-attribute 

identity_center_instance_arn: NotRequired[IdentityCenterInstanceARN]

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.

identity_center_instance_region instance-attribute 

identity_center_instance_region: NotRequired[Region]

The Region of the IAM Identity Center instance.

roles_key instance-attribute 

roles_key: NotRequired[RolesKeyIdCOption]

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

subject_key instance-attribute 

subject_key: NotRequired[SubjectKeyIdCOption]

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.