codegen-resources.docs-2.json Maven / Gradle / Ivy
Show all versions of connect Show documentation
{
"version": "2.0",
"service": "The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.
There is a throttling limit placed on usage of the Amazon Connect operations that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.
",
"operations": {
"CreateUser": "Creates a new user account in your Amazon Connect instance.
",
"DeleteUser": "Deletes a user account from Amazon Connect.
",
"DescribeUser": "Returns a User object that contains information about the user account specified by the UserId.
",
"DescribeUserHierarchyGroup": "Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
",
"DescribeUserHierarchyStructure": "Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.
",
"GetCurrentMetricData": "The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.
",
"GetFederationToken": "Retrieves a token for federation.
",
"GetMetricData": "The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
If you are using an IAM account, it must have permission to the connect:GetMetricData action.
",
"ListRoutingProfiles": "Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.
",
"ListSecurityProfiles": "Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
",
"ListUserHierarchyGroups": "Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.
",
"ListUsers": "Returns a UserSummaryList, which is an array of UserSummary objects.
",
"StartOutboundVoiceContact": "The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.
",
"StopContact": "Ends the contact initiated by the StartOutboundVoiceContact operation.
If you are using an IAM account, it must have permission to the connect:StopContact action.
",
"UpdateContactAttributes": "The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted.
Important:
You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
",
"UpdateUserHierarchy": "Assigns the specified hierarchy group to the user.
",
"UpdateUserIdentityInfo": "Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.
",
"UpdateUserPhoneConfig": "Updates the phone configuration settings in the UserPhoneConfig object for the specified user.
",
"UpdateUserRoutingProfile": "Assigns the specified routing profile to a user.
",
"UpdateUserSecurityProfiles": "Updates the security profiles assigned to the user.
"
},
"shapes": {
"ARN": {
"base": null,
"refs": {
"CreateUserResponse$UserArn": "The Amazon Resource Name (ARN) of the user account created.
",
"HierarchyGroup$Arn": "The Amazon Resource Name (ARN) for the hierarchy group.
",
"HierarchyGroupSummary$Arn": "The ARN for the hierarchy group.
",
"HierarchyLevel$Arn": "The ARN for the hierarchy group level.
",
"QueueReference$Arn": "The Amazon Resource Name (ARN) of queue.
",
"RoutingProfileSummary$Arn": "The ARN of the routing profile.
",
"SecurityProfileSummary$Arn": "The ARN of the security profile.
",
"User$Arn": "The ARN of the user account.
",
"UserSummary$Arn": "The ARN for the user account.
"
}
},
"AfterContactWorkTimeLimit": {
"base": null,
"refs": {
"UserPhoneConfig$AfterContactWorkTimeLimit": "The After Call Work (ACW) timeout setting, in seconds, for the user.
"
}
},
"AgentFirstName": {
"base": null,
"refs": {
"UserIdentityInfo$FirstName": "The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.
"
}
},
"AgentLastName": {
"base": null,
"refs": {
"UserIdentityInfo$LastName": "The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.
"
}
},
"AgentUsername": {
"base": null,
"refs": {
"CreateUserRequest$Username": "The user name in Amazon Connect for the account to create.
",
"User$Username": "The user name assigned to the user account.
",
"UserSummary$Username": "The Amazon Connect user name for the user account.
"
}
},
"AttributeName": {
"base": null,
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": null,
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": null,
"refs": {
"StartOutboundVoiceContactRequest$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:
",
"UpdateContactAttributesRequest$Attributes": "The key-value pairs for the attribute to update.
"
}
},
"AutoAccept": {
"base": null,
"refs": {
"UserPhoneConfig$AutoAccept": "The Auto accept setting for the user, Yes or No.
"
}
},
"Channel": {
"base": null,
"refs": {
"Channels$member": null,
"Dimensions$Channel": "The channel used for grouping and filters. Only VOICE is supported.
"
}
},
"Channels": {
"base": null,
"refs": {
"Filters$Channels": "The Channel to use as a filter for the metrics returned. Only VOICE is supported.
"
}
},
"ClientToken": {
"base": null,
"refs": {
"StartOutboundVoiceContactRequest$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.
"
}
},
"Comparison": {
"base": null,
"refs": {
"Threshold$Comparison": "The Threshold to use to compare service level metrics to. Only \"Less than\" (LT) comparisons are supported.
"
}
},
"ContactFlowId": {
"base": null,
"refs": {
"StartOutboundVoiceContactRequest$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.
"
}
},
"ContactId": {
"base": null,
"refs": {
"StartOutboundVoiceContactResponse$ContactId": "The unique identifier of this contact within your Amazon Connect instance.
",
"StopContactRequest$ContactId": "The unique identifier of the contact to end.
",
"UpdateContactAttributesRequest$InitialContactId": "The unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center.
"
}
},
"ContactNotFoundException": {
"base": "The contact with the specified ID is not active or does not exist.
",
"refs": {
}
},
"CreateUserRequest": {
"base": null,
"refs": {
}
},
"CreateUserResponse": {
"base": null,
"refs": {
}
},
"Credentials": {
"base": "The credentials to use for federation.
",
"refs": {
"GetFederationTokenResponse$Credentials": "The credentials to use for federation.
"
}
},
"CurrentMetric": {
"base": "A CurrentMetric object that contains the Name and Unit for the metric.
",
"refs": {
"CurrentMetricData$Metric": "The metric in a CurrentMetricData object.
",
"CurrentMetrics$member": null
}
},
"CurrentMetricData": {
"base": "A CurrentMetricData object.
",
"refs": {
"CurrentMetricDataCollections$member": null
}
},
"CurrentMetricDataCollections": {
"base": null,
"refs": {
"CurrentMetricResult$Collections": "The Collections for the CurrentMetricResult object.
"
}
},
"CurrentMetricName": {
"base": "A list of current metric names.
",
"refs": {
"CurrentMetric$Name": "The name of the metric.
"
}
},
"CurrentMetricResult": {
"base": "A CurrentMetricResult object.
",
"refs": {
"CurrentMetricResults$member": null
}
},
"CurrentMetricResults": {
"base": null,
"refs": {
"GetCurrentMetricDataResponse$MetricResults": "A list of CurrentMetricResult objects organized by Dimensions combining with CurrentMetricDataCollections.
Dimensions is the resourceId specified in the Filters of the request.
Collections is a list of CurrentMetricData objects with corresponding values to the CurrentMetrics specified in the request.
If no Grouping is specified in the request, Collections is a summary for the CurrentMetric returned.
"
}
},
"CurrentMetrics": {
"base": null,
"refs": {
"GetCurrentMetricDataRequest$CurrentMetrics": "A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.
The following metrics are available:
- AGENTS_AVAILABLE
-
Unit: COUNT
- AGENTS_ONLINE
-
Unit: COUNT
- AGENTS_ON_CALL
-
Unit: COUNT
- AGENTS_STAFFED
-
Unit: COUNT
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
- AGENTS_ERROR
-
Unit: COUNT
- CONTACTS_IN_QUEUE
-
Unit: COUNT
- OLDEST_CONTACT_AGE
-
Unit: SECONDS
- CONTACTS_SCHEDULED
-
Unit: COUNT
"
}
},
"DeleteUserRequest": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyGroupRequest": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyGroupResponse": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyStructureRequest": {
"base": null,
"refs": {
}
},
"DescribeUserHierarchyStructureResponse": {
"base": null,
"refs": {
}
},
"DescribeUserRequest": {
"base": null,
"refs": {
}
},
"DescribeUserResponse": {
"base": null,
"refs": {
}
},
"DestinationNotAllowedException": {
"base": "Outbound calls to the destination number are not allowed.
",
"refs": {
}
},
"Dimensions": {
"base": "A Dimensions object that includes the Channel and Queue for the metric.
",
"refs": {
"CurrentMetricResult$Dimensions": "The Dimensions for the CurrentMetricResult object.
",
"HistoricalMetricResult$Dimensions": "The Dimensions for the metrics.
"
}
},
"DirectoryUserId": {
"base": null,
"refs": {
"CreateUserRequest$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.
",
"User$DirectoryUserId": "The directory Id for the user account in the existing directory used for identity management.
"
}
},
"DuplicateResourceException": {
"base": "A resource with that name already exists.
",
"refs": {
}
},
"Email": {
"base": null,
"refs": {
"UserIdentityInfo$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.
"
}
},
"Filters": {
"base": "The filter, either channel or queues, to apply to the metric results retrieved.
",
"refs": {
"GetCurrentMetricDataRequest$Filters": "A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.
",
"GetMetricDataRequest$Filters": "A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.
To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.
"
}
},
"GetCurrentMetricDataRequest": {
"base": null,
"refs": {
}
},
"GetCurrentMetricDataResponse": {
"base": null,
"refs": {
}
},
"GetFederationTokenRequest": {
"base": null,
"refs": {
}
},
"GetFederationTokenResponse": {
"base": null,
"refs": {
}
},
"GetMetricDataRequest": {
"base": null,
"refs": {
}
},
"GetMetricDataResponse": {
"base": null,
"refs": {
}
},
"Grouping": {
"base": null,
"refs": {
"Groupings$member": null
}
},
"Groupings": {
"base": null,
"refs": {
"GetCurrentMetricDataRequest$Groupings": "The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.
If no Grouping is included in the request, a summary of CurrentMetrics is returned.
",
"GetMetricDataRequest$Groupings": "The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The current version supports grouping by Queue
If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.
"
}
},
"HierarchyGroup": {
"base": "A HierarchyGroup object that contains information about a hierarchy group in your Amazon Connect instance.
",
"refs": {
"DescribeUserHierarchyGroupResponse$HierarchyGroup": "Returns a HierarchyGroup object.
"
}
},
"HierarchyGroupId": {
"base": null,
"refs": {
"CreateUserRequest$HierarchyGroupId": "The unique identifier for the hierarchy group to assign to the user created.
",
"DescribeUserHierarchyGroupRequest$HierarchyGroupId": "The identifier for the hierarchy group to return.
",
"HierarchyGroup$Id": "The identifier for the hierarchy group.
",
"HierarchyGroupSummary$Id": "The identifier of the hierarchy group.
",
"UpdateUserHierarchyRequest$HierarchyGroupId": "The identifier for the hierarchy group to assign to the user.
",
"User$HierarchyGroupId": "The identifier for the hierarchy group assigned to the user.
"
}
},
"HierarchyGroupName": {
"base": null,
"refs": {
"HierarchyGroup$Name": "The name of the hierarchy group in your instance.
",
"HierarchyGroupSummary$Name": "The name of the hierarchy group.
"
}
},
"HierarchyGroupSummary": {
"base": "A HierarchyGroupSummary object that contains information about the hierarchy group, including ARN, Id, and Name.
",
"refs": {
"HierarchyGroupSummaryList$member": null,
"HierarchyPath$LevelOne": "A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
",
"HierarchyPath$LevelTwo": "A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
",
"HierarchyPath$LevelThree": "A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
",
"HierarchyPath$LevelFour": "A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
",
"HierarchyPath$LevelFive": "A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.
"
}
},
"HierarchyGroupSummaryList": {
"base": null,
"refs": {
"ListUserHierarchyGroupsResponse$UserHierarchyGroupSummaryList": "An array of HierarchyGroupSummary objects.
"
}
},
"HierarchyLevel": {
"base": "A HierarchyLevel object that contains information about the levels in a hierarchy group, including ARN, Id, and Name.
",
"refs": {
"HierarchyStructure$LevelOne": "A HierarchyLevel object that contains information about the hierarchy group level.
",
"HierarchyStructure$LevelTwo": "A HierarchyLevel object that contains information about the hierarchy group level.
",
"HierarchyStructure$LevelThree": "A HierarchyLevel object that contains information about the hierarchy group level.
",
"HierarchyStructure$LevelFour": "A HierarchyLevel object that contains information about the hierarchy group level.
",
"HierarchyStructure$LevelFive": "A HierarchyLevel object that contains information about the hierarchy group level.
"
}
},
"HierarchyLevelId": {
"base": null,
"refs": {
"HierarchyGroup$LevelId": "The identifier for the level in the hierarchy group.
",
"HierarchyLevel$Id": "The identifier for the hierarchy group level.
"
}
},
"HierarchyLevelName": {
"base": null,
"refs": {
"HierarchyLevel$Name": "The name of the hierarchy group level.
"
}
},
"HierarchyPath": {
"base": "A HierarchyPath object that contains information about the levels of the hierarchy group.
",
"refs": {
"HierarchyGroup$HierarchyPath": "A HierarchyPath object that contains information about the levels in the hierarchy group.
"
}
},
"HierarchyStructure": {
"base": "A HierarchyStructure object that contains information about the hierarchy group structure.
",
"refs": {
"DescribeUserHierarchyStructureResponse$HierarchyStructure": "A HierarchyStructure object.
"
}
},
"HistoricalMetric": {
"base": "A HistoricalMetric object that contains the Name, Unit, Statistic, and Threshold for the metric.
",
"refs": {
"HistoricalMetricData$Metric": "A HistoricalMetric object.
",
"HistoricalMetrics$member": null
}
},
"HistoricalMetricData": {
"base": "A HistoricalMetricData object than contains a Metric and a Value.
",
"refs": {
"HistoricalMetricDataCollections$member": null
}
},
"HistoricalMetricDataCollections": {
"base": null,
"refs": {
"HistoricalMetricResult$Collections": "A list of HistoricalMetricData objects.
"
}
},
"HistoricalMetricName": {
"base": "A list of historical metric names.
",
"refs": {
"HistoricalMetric$Name": "The name of the historical metric.
"
}
},
"HistoricalMetricResult": {
"base": "The metrics data returned from a GetMetricData operation.
",
"refs": {
"HistoricalMetricResults$member": null
}
},
"HistoricalMetricResults": {
"base": null,
"refs": {
"GetMetricDataResponse$MetricResults": "A list of HistoricalMetricResult objects, organized by Dimensions, which is the ID of the resource specified in the Filters used for the request. The metrics are combined with the metrics included in Collections, which is a list of HisotricalMetricData objects.
If no Grouping is specified in the request, Collections includes summary data for the HistoricalMetrics.
"
}
},
"HistoricalMetrics": {
"base": null,
"refs": {
"GetMetricDataRequest$HistoricalMetrics": "A list of HistoricalMetric objects that contain the metrics to retrieve with the request.
A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.
For each historical metric you include in the request, you must include a Unit and a Statistic.
The following historical metrics are available:
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED
-
Unit: COUNT
Statistics: SUM
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistics: SUM
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistics: SUM
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistics: SUM
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistics: SUM
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistics: SUM
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistics: SUM
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistics: SUM
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistics: SUM
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistics: SUM
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistics: SUM
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistics: SUM
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistics: SUM
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistics: SUM
- CONTACTS_MISSED
-
Unit: COUNT
Statistics: SUM
- OCCUPANCY
-
Unit: PERCENT
Statistics: AVG
- HANDLE_TIME
-
Unit: SECONDS
Statistics: AVG
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistics: AVG
- QUEUED_TIME
-
Unit: SECONDS
Statistics: MAX
- ABANDON_TIME
-
Unit: COUNT
Statistics: SUM
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistics: AVG
- HOLD_TIME
-
Unit: SECONDS
Statistics: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistics: AVG
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistics: AVG
- SERVICE_LEVEL
-
Unit: PERCENT
Statistics: AVG
Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
"
}
},
"InstanceId": {
"base": null,
"refs": {
"CreateUserRequest$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.
",
"DeleteUserRequest$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.
",
"DescribeUserHierarchyGroupRequest$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.
",
"DescribeUserHierarchyStructureRequest$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.
",
"DescribeUserRequest$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.
",
"GetCurrentMetricDataRequest$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.
",
"GetFederationTokenRequest$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.
",
"GetMetricDataRequest$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.
",
"ListRoutingProfilesRequest$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.
",
"ListSecurityProfilesRequest$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.
",
"ListUserHierarchyGroupsRequest$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.
",
"ListUsersRequest$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.
",
"StartOutboundVoiceContactRequest$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.
",
"StopContactRequest$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.
",
"UpdateContactAttributesRequest$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.
",
"UpdateUserHierarchyRequest$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.
",
"UpdateUserIdentityInfoRequest$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.
",
"UpdateUserPhoneConfigRequest$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.
",
"UpdateUserRoutingProfileRequest$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.
",
"UpdateUserSecurityProfilesRequest$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.
"
}
},
"InternalServiceException": {
"base": "Request processing failed due to an error or failure with the service.
",
"refs": {
}
},
"InvalidParameterException": {
"base": "One or more of the parameters provided to the operation are not valid.
",
"refs": {
}
},
"InvalidRequestException": {
"base": "The request is not valid.
",
"refs": {
}
},
"LimitExceededException": {
"base": "The allowed limit for the resource has been reached.
",
"refs": {
}
},
"ListRoutingProfilesRequest": {
"base": null,
"refs": {
}
},
"ListRoutingProfilesResponse": {
"base": null,
"refs": {
}
},
"ListSecurityProfilesRequest": {
"base": null,
"refs": {
}
},
"ListSecurityProfilesResponse": {
"base": null,
"refs": {
}
},
"ListUserHierarchyGroupsRequest": {
"base": null,
"refs": {
}
},
"ListUserHierarchyGroupsResponse": {
"base": null,
"refs": {
}
},
"ListUsersRequest": {
"base": null,
"refs": {
}
},
"ListUsersResponse": {
"base": null,
"refs": {
}
},
"MaxResult100": {
"base": null,
"refs": {
"GetCurrentMetricDataRequest$MaxResults": " MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.
",
"GetMetricDataRequest$MaxResults": "Indicates the maximum number of results to return per page in the response, between 1-100.
"
}
},
"MaxResult1000": {
"base": null,
"refs": {
"ListRoutingProfilesRequest$MaxResults": "The maximum number of routing profiles to return in the response.
",
"ListSecurityProfilesRequest$MaxResults": "The maximum number of security profiles to return.
",
"ListUserHierarchyGroupsRequest$MaxResults": "The maximum number of hierarchy groups to return.
",
"ListUsersRequest$MaxResults": "The maximum number of results to return in the response.
"
}
},
"Message": {
"base": null,
"refs": {
"ContactNotFoundException$Message": "The message.
",
"DestinationNotAllowedException$Message": "The message.
",
"DuplicateResourceException$Message": null,
"InternalServiceException$Message": "The message.
",
"InvalidParameterException$Message": "The message.
",
"InvalidRequestException$Message": "The message.
",
"LimitExceededException$Message": "The message.
",
"OutboundContactNotPermittedException$Message": "The message.
",
"ResourceNotFoundException$Message": "The message.
",
"ThrottlingException$Message": null,
"UserNotFoundException$Message": null
}
},
"NextToken": {
"base": null,
"refs": {
"GetCurrentMetricDataRequest$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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
",
"GetCurrentMetricDataResponse$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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
",
"GetMetricDataRequest$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.
",
"GetMetricDataResponse$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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.
",
"ListRoutingProfilesRequest$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.
",
"ListRoutingProfilesResponse$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.
",
"ListSecurityProfilesRequest$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.
",
"ListSecurityProfilesResponse$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.
",
"ListUserHierarchyGroupsRequest$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.
",
"ListUserHierarchyGroupsResponse$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.
",
"ListUsersRequest$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.
",
"ListUsersResponse$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.
"
}
},
"OutboundContactNotPermittedException": {
"base": "The contact is not permitted.
",
"refs": {
}
},
"Password": {
"base": null,
"refs": {
"CreateUserRequest$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.
"
}
},
"PhoneNumber": {
"base": null,
"refs": {
"StartOutboundVoiceContactRequest$DestinationPhoneNumber": "The phone number of the customer in E.164 format.
",
"StartOutboundVoiceContactRequest$SourcePhoneNumber": "The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.
",
"UserPhoneConfig$DeskPhoneNumber": "The phone number for the user's desk phone.
"
}
},
"PhoneType": {
"base": null,
"refs": {
"UserPhoneConfig$PhoneType": "The phone type selected for the user, either Soft phone or Desk phone.
"
}
},
"QueueId": {
"base": null,
"refs": {
"QueueReference$Id": "The ID of the queue associated with the metrics returned.
",
"Queues$member": null,
"StartOutboundVoiceContactRequest$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.
"
}
},
"QueueReference": {
"base": "A QueueReference object that contains the the QueueId and ARN for the queue resource for which metrics are returned.
",
"refs": {
"Dimensions$Queue": "A QueueReference object used as one part of dimension for the metrics results.
"
}
},
"Queues": {
"base": null,
"refs": {
"Filters$Queues": "A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.
"
}
},
"ResourceNotFoundException": {
"base": "The specified resource was not found.
",
"refs": {
}
},
"RoutingProfileId": {
"base": null,
"refs": {
"CreateUserRequest$RoutingProfileId": "The unique identifier for the routing profile to assign to the user created.
",
"RoutingProfileSummary$Id": "The identifier of the routing profile.
",
"UpdateUserRoutingProfileRequest$RoutingProfileId": "The identifier of the routing profile to assign to the user.
",
"User$RoutingProfileId": "The identifier of the routing profile assigned to the user.
"
}
},
"RoutingProfileName": {
"base": null,
"refs": {
"RoutingProfileSummary$Name": "The name of the routing profile.
"
}
},
"RoutingProfileSummary": {
"base": "A RoutingProfileSummary object that contains information about a routing profile, including ARN, Id, and Name.
",
"refs": {
"RoutingProfileSummaryList$member": null
}
},
"RoutingProfileSummaryList": {
"base": null,
"refs": {
"ListRoutingProfilesResponse$RoutingProfileSummaryList": "An array of RoutingProfileSummary objects that include the ARN, Id, and Name of the routing profile.
"
}
},
"SecurityProfileId": {
"base": null,
"refs": {
"SecurityProfileIds$member": null,
"SecurityProfileSummary$Id": "The identifier of the security profile.
"
}
},
"SecurityProfileIds": {
"base": null,
"refs": {
"CreateUserRequest$SecurityProfileIds": "The unique identifier of the security profile to assign to the user created.
",
"UpdateUserSecurityProfilesRequest$SecurityProfileIds": "The identifiers for the security profiles to assign to the user.
",
"User$SecurityProfileIds": "The identifier(s) for the security profile assigned to the user.
"
}
},
"SecurityProfileName": {
"base": null,
"refs": {
"SecurityProfileSummary$Name": "The name of the security profile.
"
}
},
"SecurityProfileSummary": {
"base": "A SecurityProfileSummary object that contains information about a security profile, including ARN, Id, Name.
",
"refs": {
"SecurityProfileSummaryList$member": null
}
},
"SecurityProfileSummaryList": {
"base": null,
"refs": {
"ListSecurityProfilesResponse$SecurityProfileSummaryList": "An array of SecurityProfileSummary objects.
"
}
},
"SecurityToken": {
"base": null,
"refs": {
"Credentials$AccessToken": "An access token generated for a federated user to access Amazon Connect
",
"Credentials$RefreshToken": "Renews a token generated for a user to access the Amazon Connect instance.
"
}
},
"StartOutboundVoiceContactRequest": {
"base": null,
"refs": {
}
},
"StartOutboundVoiceContactResponse": {
"base": null,
"refs": {
}
},
"Statistic": {
"base": null,
"refs": {
"HistoricalMetric$Statistic": "The statistic for the metric: SUM, MAX, or SUM.
"
}
},
"StopContactRequest": {
"base": null,
"refs": {
}
},
"StopContactResponse": {
"base": null,
"refs": {
}
},
"Threshold": {
"base": "A Threshold object that includes a comparison and ThresholdValue to compare to. Used with service level metrics.
",
"refs": {
"HistoricalMetric$Threshold": "The threshold for the metric, used with service level metrics.
"
}
},
"ThresholdValue": {
"base": null,
"refs": {
"Threshold$ThresholdValue": "The value of the threshold to compare the metric to. Only \"Less than\" (LT) comparisons are supported.
"
}
},
"ThrottlingException": {
"base": "The throttling limit has been exceeded.
",
"refs": {
}
},
"Unit": {
"base": null,
"refs": {
"CurrentMetric$Unit": "The unit for the metric.
",
"HistoricalMetric$Unit": "The unit for the metric: COUNT, PERCENT, or SECONDS.
"
}
},
"UpdateContactAttributesRequest": {
"base": null,
"refs": {
}
},
"UpdateContactAttributesResponse": {
"base": null,
"refs": {
}
},
"UpdateUserHierarchyRequest": {
"base": null,
"refs": {
}
},
"UpdateUserIdentityInfoRequest": {
"base": null,
"refs": {
}
},
"UpdateUserPhoneConfigRequest": {
"base": null,
"refs": {
}
},
"UpdateUserRoutingProfileRequest": {
"base": null,
"refs": {
}
},
"UpdateUserSecurityProfilesRequest": {
"base": null,
"refs": {
}
},
"User": {
"base": "A User object that contains information about a user account in your Amazon Connect instance, including configuration settings.
",
"refs": {
"DescribeUserResponse$User": "A User object that contains information about the user account and configuration settings.
"
}
},
"UserId": {
"base": null,
"refs": {
"CreateUserResponse$UserId": "The unique identifier for the user account in Amazon Connect
",
"DeleteUserRequest$UserId": "The unique identifier of the user to delete.
",
"DescribeUserRequest$UserId": "Unique identifier for the user account to return.
",
"UpdateUserHierarchyRequest$UserId": "The identifier of the user account to assign the hierarchy group to.
",
"UpdateUserIdentityInfoRequest$UserId": "The identifier for the user account to update identity information for.
",
"UpdateUserPhoneConfigRequest$UserId": "The identifier for the user account to change phone settings for.
",
"UpdateUserRoutingProfileRequest$UserId": "The identifier for the user account to assign the routing profile to.
",
"UpdateUserSecurityProfilesRequest$UserId": "The identifier of the user account to assign the security profiles.
",
"User$Id": "The identifier of the user account.
",
"UserSummary$Id": "The identifier for the user account.
"
}
},
"UserIdentityInfo": {
"base": "A UserIdentityInfo object that contains information about the user's identity, including email address, first name, and last name.
",
"refs": {
"CreateUserRequest$IdentityInfo": "Information about the user, including email address, first name, and last name.
",
"UpdateUserIdentityInfoRequest$IdentityInfo": "A UserIdentityInfo object.
",
"User$IdentityInfo": "A UserIdentityInfo object.
"
}
},
"UserNotFoundException": {
"base": "No user with the specified credentials was found in the Amazon Connect instance.
",
"refs": {
}
},
"UserPhoneConfig": {
"base": "A UserPhoneConfig object that contains information about the user phone configuration settings.
",
"refs": {
"CreateUserRequest$PhoneConfig": "Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.
",
"UpdateUserPhoneConfigRequest$PhoneConfig": "A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.
",
"User$PhoneConfig": "A UserPhoneConfig object.
"
}
},
"UserSummary": {
"base": "A UserSummary object that contains Information about a user, including ARN, Id, and user name.
",
"refs": {
"UserSummaryList$member": null
}
},
"UserSummaryList": {
"base": null,
"refs": {
"ListUsersResponse$UserSummaryList": "An array of UserSummary objects that contain information about the users in your instance.
"
}
},
"Value": {
"base": null,
"refs": {
"CurrentMetricData$Value": "The value of the metric in the CurrentMetricData object.
",
"HistoricalMetricData$Value": "The Value of the metric.
"
}
},
"timestamp": {
"base": null,
"refs": {
"Credentials$AccessTokenExpiration": "A token generated with an expiration time for the session a user is logged in to Amazon Connect
",
"Credentials$RefreshTokenExpiration": "Renews the expiration timer for a generated token.
",
"GetCurrentMetricDataResponse$DataSnapshotTime": "The time at which CurrentMetricData was retrieved and cached for pagination.
",
"GetMetricDataRequest$StartTime": "The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.
",
"GetMetricDataRequest$EndTime": "The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the StartTime timestamp.
The time range between StartTime and EndTime must be less than 24 hours.
"
}
}
}
}