Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

create-security-profile

Description

Creates a 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

Synopsis

  create-security-profile
--security-profile-name <value>
[--description <value>]
[--permissions <value>]
--instance-id <value>
[--tags <value>]
[--allowed-access-control-tags <value>]
[--tag-restricted-resources <value>]
[--applications <value>]
[--hierarchy-restricted-resources <value>]
[--allowed-access-control-hierarchy-group-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--security-profile-name (string)

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)

Syntax:

"string" "string" ...

--instance-id (string)

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

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--allowed-access-control-tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--tag-restricted-resources (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)

Syntax:

"string" "string" ...

--applications (list)

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

(structure)

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)

Shorthand Syntax:

Namespace=string,ApplicationPermissions=string,string ...

JSON Syntax:

[
  {
    "Namespace": "string",
    "ApplicationPermissions": ["string", ...]
  }
  ...
]

--hierarchy-restricted-resources (list)

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

(string)

Syntax:

"string" "string" ...

--allowed-access-control-hierarchy-group-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

SecurityProfileId -> (string)

The identifier for the security profle.

SecurityProfileArn -> (string)

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