Connect / Client / create_security_profile

create_security_profile#

Connect.Client.create_security_profile(**kwargs)#

Creates a security profile.

See also: AWS API Documentation

Request Syntax

response = client.create_security_profile(
    SecurityProfileName='string',
    Description='string',
    Permissions=[
        'string',
    ],
    InstanceId='string',
    Tags={
        'string': 'string'
    },
    AllowedAccessControlTags={
        'string': 'string'
    },
    TagRestrictedResources=[
        'string',
    ],
    Applications=[
        {
            'Namespace': 'string',
            'ApplicationPermissions': [
                'string',
            ]
        },
    ],
    HierarchyRestrictedResources=[
        'string',
    ],
    AllowedAccessControlHierarchyGroupId='string'
)
Parameters:
  • SecurityProfileName (string) –

    [REQUIRED]

    The name of the security profile.

  • Description (string) – The description of the security profile.

  • Permissions (list) –

    Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.

    • (string) –

  • 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.

  • 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. Following are acceptable ResourceNames: User | SecurityProfile | Queue | RoutingProfile

    • (string) –

  • Applications (list) –

    A list of third-party applications that the security profile will give access to.

    • (dict) –

      This API is in preview release for Amazon Connect and is subject to change.

      A third-party application’s metadata.

      • Namespace (string) –

        Namespace of the application that you want to give access to.

      • ApplicationPermissions (list) –

        The permissions that the agent is granted on the application. Only the ACCESS permission is supported.

        • (string) –

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'SecurityProfileId': 'string',
    'SecurityProfileArn': 'string'
}

Response Structure

  • (dict) –

    • SecurityProfileId (string) –

      The identifier for the security profle.

    • SecurityProfileArn (string) –

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

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.LimitExceededException

  • Connect.Client.exceptions.DuplicateResourceException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException