awscc.connect_user¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - connect:DeleteUser, connect:UntagResource
update¶
Parent base class for filters and actions.
definitions:
AfterContactWorkTimeLimit:
description: The After Call Work (ACW) timeout setting, in seconds.
minimum: 0
type: integer
AutoAccept:
description: The Auto accept setting.
type: boolean
DeskPhoneNumber:
description: The phone number for the user's desk phone.
type: string
Email:
description: The email address. If you are using SAML for identity management
and include this parameter, an error is returned.
type: string
FirstName:
description: The first name. This is required if you are using Amazon Connect
or SAML for identity management.
type: string
LastName:
description: The last name. This is required if you are using Amazon Connect or
SAML for identity management.
type: string
PhoneType:
description: The phone type.
enum:
- SOFT_PHONE
- DESK_PHONE
type: string
SecurityProfileArn:
description: The identifier of the security profile for the user.
pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$
type: string
Tag:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1 to
128 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
type: string
Value:
description: 'The value for the tag. You can specify a value that is maximum
of 256 Unicode characters in length and cannot be prefixed with aws:. You
can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
type: string
required:
- Key
- Value
type: object
UserIdentityInfo:
additionalProperties: false
description: Contains information about the identity of a user.
properties:
Email:
description: The email address. If you are using SAML for identity management
and include this parameter, an error is returned.
type: string
FirstName:
description: The first name. This is required if you are using Amazon Connect
or SAML for identity management.
type: string
LastName:
description: The last name. This is required if you are using Amazon Connect
or SAML for identity management.
type: string
type: object
UserPhoneConfig:
additionalProperties: false
description: Contains information about the phone configuration settings for a
user.
properties:
AfterContactWorkTimeLimit:
description: The After Call Work (ACW) timeout setting, in seconds.
minimum: 0
type: integer
AutoAccept:
description: The Auto accept setting.
type: boolean
DeskPhoneNumber:
description: The phone number for the user's desk phone.
type: string
PhoneType:
description: The phone type.
enum:
- SOFT_PHONE
- DESK_PHONE
type: string
required:
- PhoneType
type: object
properties:
DirectoryUserId:
description: The identifier of the user account in the directory used for identity
management.
type: string
HierarchyGroupArn:
description: The identifier of the hierarchy group for the user.
pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/agent-group/[-a-zA-Z0-9]*$
type: string
IdentityInfo:
additionalProperties: false
description: Contains information about the identity of a user.
properties:
Email:
description: The email address. If you are using SAML for identity management
and include this parameter, an error is returned.
type: string
FirstName:
description: The first name. This is required if you are using Amazon Connect
or SAML for identity management.
type: string
LastName:
description: The last name. This is required if you are using Amazon Connect
or SAML for identity management.
type: string
type: object
InstanceArn:
description: The identifier of the Amazon Connect instance.
pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*$
type: string
Password:
description: The password for the user account. A password is required if you
are using Amazon Connect for identity management. Otherwise, it is an error
to include a password.
pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$
type: string
PhoneConfig:
additionalProperties: false
description: Contains information about the phone configuration settings for a
user.
properties:
AfterContactWorkTimeLimit:
description: The After Call Work (ACW) timeout setting, in seconds.
minimum: 0
type: integer
AutoAccept:
description: The Auto accept setting.
type: boolean
DeskPhoneNumber:
description: The phone number for the user's desk phone.
type: string
PhoneType:
description: The phone type.
enum:
- SOFT_PHONE
- DESK_PHONE
type: string
required:
- PhoneType
type: object
RoutingProfileArn:
description: The identifier of the routing profile for the user.
pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/routing-profile/[-a-zA-Z0-9]*$
type: string
SecurityProfileArns:
description: One or more security profile arns for the user
insertionOrder: false
items:
description: The identifier of the security profile for the user.
pattern: ^arn:aws[-a-z0-9]*:connect:[-a-z0-9]*:[0-9]{12}:instance/[-a-zA-Z0-9]*/security-profile/[-a-zA-Z0-9]*$
type: string
maxItems: 10
minItems: 1
type: array
uniqueItems: true
Tags:
description: One or more tags.
insertionOrder: false
items:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1
to 128 Unicode characters in length and cannot be prefixed with aws:.
You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
type: string
Value:
description: 'The value for the tag. You can specify a value that is maximum
of 256 Unicode characters in length and cannot be prefixed with aws:.
You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -. '
maxLength: 256
type: string
required:
- Key
- Value
type: object
maxItems: 50
type: array
uniqueItems: true
Username:
description: The user name for the account.
maxLength: 64
minLength: 1
pattern: '[a-zA-Z0-9\_\-\.\@]+'
type: string
type:
enum:
- update
Permissions - connect:UpdateUserIdentityInfo, connect:UpdateUserPhoneConfig, connect:UpdateUserRoutingProfile, connect:UpdateUserSecurityProfiles, connect:UpdateUserHierarchy, connect:TagResource, connect:UntagResource