Connect / Client / describe_security_profile

describe_security_profile#

Connect.Client.describe_security_profile(**kwargs)#

Gets basic information about the security profile.

For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_security_profile(
    SecurityProfileId='string',
    InstanceId='string'
)
Parameters:

  • SecurityProfileId (string) –

    [REQUIRED]

    The identifier for the security profle.

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Return type:

dict

Returns:

Response Syntax

{
    'SecurityProfile': {
        'Id': 'string',
        'OrganizationResourceId': 'string',
        'Arn': 'string',
        'SecurityProfileName': 'string',
        'Description': 'string',
        'Tags': {
            'string': 'string'
        },
        'AllowedAccessControlTags': {
            'string': 'string'
        },
        'TagRestrictedResources': [
            'string',
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string',
        'HierarchyRestrictedResources': [
            'string',
        ],
        'AllowedAccessControlHierarchyGroupId': 'string'
    }
}

Response Structure

  • (dict) –

    • SecurityProfile (dict) –

      The security profile.

      • Id (string) –

        The identifier for the security profile.

      • OrganizationResourceId (string) –

        The organization resource identifier for the security profile.

      • Arn (string) –

        The Amazon Resource Name (ARN) for the security profile.

      • SecurityProfileName (string) –

        The name for the security profile.

      • Description (string) –

        The description of the security profile.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

        • (string) –

          • (string) –

      • AllowedAccessControlTags (dict) –

        The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

        • (string) –

          • (string) –

      • TagRestrictedResources (list) –

        The list of resources that a security profile applies tag restrictions to in Amazon Connect.

        • (string) –

      • LastModifiedTime (datetime) –

        The timestamp when this resource was last modified.

      • LastModifiedRegion (string) –

        The Amazon Web Services Region where this resource was last modified.

      • HierarchyRestrictedResources (list) –

        The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

        • (string) –

      • AllowedAccessControlHierarchyGroupId (string) –

        The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.

Exceptions