String username
The user name in Amazon Connect for the user to create.
String password
The password for the user account to create. This is required if you are using Amazon Connect for identity
management. If you are using SAML for identity management and include this parameter, an
InvalidRequestException is returned.
UserIdentityInfo identityInfo
Information about the user, including email address, first name, and last name.
UserPhoneConfig phoneConfig
Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
String directoryUserId
The unique identifier for the user account in the directory service directory used for identity management. If
Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to
authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory.
If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing
directory.
This parameter is required if you are using an existing directory for identity management in Amazon Connect when
Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management
and include this parameter, an InvalidRequestException is returned.
List<E> securityProfileIds
The unique identifier of the security profile to assign to the user created.
String routingProfileId
The unique identifier for the routing profile to assign to the user created.
String hierarchyGroupId
The unique identifier for the hierarchy group to assign to the user created.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String accessToken
An access token generated for a federated user to access Amazon Connect
Date accessTokenExpiration
A token generated with an expiration time for the session a user is logged in to Amazon Connect
String refreshToken
Renews a token generated for a user to access the Amazon Connect instance.
Date refreshTokenExpiration
Renews the expiration timer for a generated token.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String userId
The unique identifier of the user to delete.
String hierarchyGroupId
The identifier for the hierarchy group to return.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
HierarchyGroup hierarchyGroup
Returns a HierarchyGroup object.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
HierarchyStructure hierarchyStructure
A HierarchyStructure object.
String userId
Unique identifier for the user account to return.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
User user
A User object that contains information about the user account and configuration settings.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
Credentials credentials
The credentials to use for federation.
String id
The identifier for the hierarchy group.
String arn
The Amazon Resource Name (ARN) for the hierarchy group.
String name
The name of the hierarchy group in your instance.
String levelId
The identifier for the level in the hierarchy group.
HierarchyPath hierarchyPath
A HierarchyPath object that contains information about the levels in the hierarchy group.
HierarchyGroupSummary levelOne
A HierarchyGroupSummary object that contains information about the level of the hierarchy group,
including ARN, Id, and Name.
HierarchyGroupSummary levelTwo
A HierarchyGroupSummary object that contains information about the level of the hierarchy group,
including ARN, Id, and Name.
HierarchyGroupSummary levelThree
A HierarchyGroupSummary object that contains information about the level of the hierarchy group,
including ARN, Id, and Name.
HierarchyGroupSummary levelFour
A HierarchyGroupSummary object that contains information about the level of the hierarchy group,
including ARN, Id, and Name.
HierarchyGroupSummary levelFive
A HierarchyGroupSummary object that contains information about the level of the hierarchy group,
including ARN, Id, and Name.
HierarchyLevel levelOne
A HierarchyLevel object that contains information about the hierarchy group level.
HierarchyLevel levelTwo
A HierarchyLevel object that contains information about the hierarchy group level.
HierarchyLevel levelThree
A HierarchyLevel object that contains information about the hierarchy group level.
HierarchyLevel levelFour
A HierarchyLevel object that contains information about the hierarchy group level.
HierarchyLevel levelFive
A HierarchyLevel object that contains information about the hierarchy group level.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of routing profiles to return in the response.
List<E> routingProfileSummaryList
An array of RoutingProfileSummary objects that include the ARN, Id, and Name of the routing profile.
String nextToken
A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of security profiles to return.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of hierarchy groups to return.
List<E> userHierarchyGroupSummaryList
An array of HierarchyGroupSummary objects.
String nextToken
A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String nextToken
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Integer maxResults
The maximum number of results to return in the response.
List<E> userSummaryList
An array of UserSummary objects that contain information about the users in your instance.
String nextToken
A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.
String destinationPhoneNumber
The phone number of the customer in E.164 format.
String contactFlowId
The identifier for the contact flow to connect the outbound call to.
To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow
editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact
flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as
78ea8fd5-2659-4f2b-b528-699760ccfc1b.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.
String sourcePhoneNumber
The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
String queueId
The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.
To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for
the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters
at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.
Map<K,V> attributes
Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.
For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
String contactId
The unique identifier of this contact within your Amazon Connect instance.
String contactId
The unique identifier of the contact to end.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String hierarchyGroupId
The identifier for the hierarchy group to assign to the user.
String userId
The identifier of the user account to assign the hierarchy group to.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
UserIdentityInfo identityInfo
A UserIdentityInfo object.
String userId
The identifier for the user account to update identity information for.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
UserPhoneConfig phoneConfig
A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit,
AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.
String userId
The identifier for the user account to change phone settings for.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String routingProfileId
The identifier of the routing profile to assign to the user.
String userId
The identifier for the user account to assign the routing profile to.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
List<E> securityProfileIds
The identifiers for the security profiles to assign to the user.
String userId
The identifier of the user account to assign the security profiles.
String instanceId
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
String id
The identifier of the user account.
String arn
The ARN of the user account.
String username
The user name assigned to the user account.
UserIdentityInfo identityInfo
A UserIdentityInfo object.
UserPhoneConfig phoneConfig
A UserPhoneConfig object.
String directoryUserId
The directory Id for the user account in the existing directory used for identity management.
List<E> securityProfileIds
The identifier(s) for the security profile assigned to the user.
String routingProfileId
The identifier of the routing profile assigned to the user.
String hierarchyGroupId
The identifier for the hierarchy group assigned to the user.
String firstName
The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.
String lastName
The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.
String email
The email address added to the user account. If you are using SAML for identity management and include this
parameter, an InvalidRequestException is returned.
String phoneType
The phone type selected for the user, either Soft phone or Desk phone.
Boolean autoAccept
The Auto accept setting for the user, Yes or No.
Integer afterContactWorkTimeLimit
The After Call Work (ACW) timeout setting, in seconds, for the user.
String deskPhoneNumber
The phone number for the user's desk phone.
Copyright © 2018. All rights reserved.