Data retrieval APIs for Amazon Connect
Amazon Connect provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchGetAttachedFileMetadata | Get metadata for multiple attached files from an Amazon Connect instance | Read |
| BatchGetFlowAssociation | Get summary information about the flow associations for the specified Amazon Connect instance | List |
| DescribeAgentStatus | Describe agent status in an Amazon Connect instance | Read |
| DescribeAuthenticationProfile | Describe authentication profile resources in an Amazon Connect instance | Read |
| DescribeContact | Describe a contact in an Amazon Connect instance | Read |
| DescribeContactEvaluation | Describe a contact evaluation in the specified Amazon Connect instance | Read |
| DescribeContactFlow | Describe a contact flow in an Amazon Connect instance | Read |
| DescribeContactFlowModule | Describe a contact flow module in an Amazon Connect instance | Read |
| DescribeEmailAddress | Describe an email address resource in an Amazon Connect instance | Read |
| DescribeEvaluationForm | Describe an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described | Read |
| DescribeForecastingPlanningSchedulingIntegration | Describe the status of forecasting, planning, and scheduling integration on an Amazon Connect instance | Read |
| DescribeHoursOfOperation | Describe hours of operation in an Amazon Connect instance | Read |
| DescribeHoursOfOperationOverride | Describe an hours of operation override in an Amazon Connect instance | Read |
| DescribeInstance | View details of an Amazon Connect instance and is also required to create an instance | Read |
| DescribeInstanceAttribute | View the attribute details of an existing Amazon Connect instance | Read |
| DescribeInstanceStorageConfig | View the instance storage configuration for an existing Amazon Connect instance | Read |
| DescribePhoneNumber | Describe phone number resources in an Amazon Connect instance or traffic distribution group | Read |
| DescribePredefinedAttribute | Describe a predefined attribute in an Amazon Connect instance | Read |
| DescribePrompt | Describe a prompt in an Amazon Connect instance | Read |
| DescribeQueue | Describe a queue in an Amazon Connect instance | Read |
| DescribeQuickConnect | Describe a quick connect in an Amazon Connect instance | Read |
| DescribeRoutingProfile | Describe a routing profile in an Amazon Connect instance | Read |
| DescribeRule | Describe a rule in an Amazon Connect instance | Read |
| DescribeSecurityProfile | Describe a security profile in an Amazon Connect instance | Read |
| DescribeTrafficDistributionGroup | Describe a traffic distribution group | Read |
| DescribeUser | Describe a user in an Amazon Connect instance | Read |
| DescribeUserHierarchyGroup | Describe a hierarchy group for an Amazon Connect instance | Read |
| DescribeUserHierarchyStructure | Describe the hierarchy structure for an Amazon Connect instance | Read |
| DescribeView | Describe a view in an Amazon Connect instance | Read |
| DescribeVocabulary | Describe a vocabulary in an Amazon Connect instance | Read |
| GetAttachedFile | Get an attached file from an Amazon Connect instance | Read |
| GetContactAttributes | Retrieve the contact attributes for the specified contact | Read |
| GetContactMetrics | Get contact metrics in an Amazon Connect instance | Read |
| GetCurrentMetricData | Retrieve current metric data for queues and routing profiles in an Amazon Connect instance | Read |
| GetCurrentUserData | Retrieve current user data in an Amazon Connect instance | Read |
| GetEffectiveHoursOfOperations | Get effective hours of operation resources in an Amazon Connect instance | Read |
| GetFederationToken | Federate into an Amazon Connect instance when using SAML-based authentication for identity management | Read |
| GetFlowAssociation | Get information about the flow associations for the specified Amazon Connect instance | Read |
| GetMetricData | Retrieve historical metric data for queues in an Amazon Connect instance | Read |
| GetMetricDataV2 | Retrieve metric data in an Amazon Connect instance | Read |
| GetPromptFile | Get details about a prompt's presigned Amazon S3 URL in an Amazon Connect instance | Read |
| GetTaskTemplate | Get details about specified task template in an Amazon Connect instance | Read |
| GetTrafficDistribution | Read traffic distribution for a traffic distribution group | List |
| ListAgentStatuses | List agent statuses in an Amazon Connect instance | List |
| ListAnalyticsDataAssociations | List the association status of a dataset for a given Amazon Connect instance | List |
| ListAnalyticsDataLakeDataSets | List data lake datasets available to associate with for a given Amazon Connect instance | List |
| ListApprovedOrigins | View approved origins of an existing Amazon Connect instance | List |
| ListAssociatedContacts | List the contacts associated with an email address in an Amazon Connect instance | List |
| ListAuthenticationProfiles | List authentication profile resources in an Amazon Connect instance | List |
| ListBots | View the Lex bots of an existing Amazon Connect instance | List |
| ListContactEvaluations | List contact evaluations in the specified Amazon Connect instance | List |
| ListContactFlowModules | List contact flow module resources in an Amazon Connect instance | List |
| ListContactFlowVersions | List all the versions a flow in an Amazon Connect instance | List |
| ListContactFlows | List contact flow resources in an Amazon Connect instance | List |
| ListContactReferences | List references associated with a contact in an Amazon Connect instance | List |
| ListDefaultVocabularies | List default vocabularies associated with a Amazon Connect instance | List |
| ListEvaluationFormVersions | List versions of an evaluation form in the specified Amazon Connect instance | List |
| ListEvaluationForms | List evaluation forms in the specified Amazon Connect instance | List |
| ListFlowAssociations | List summary information about the flow associations for the specified Amazon Connect instance | List |
| ListHoursOfOperationOverrides | List hours of operation override resources in an Amazon Connect instance | List |
| ListHoursOfOperations | List hours of operation resources in an Amazon Connect instance | List |
| ListInstanceAttributes | View the attributes of an existing Amazon Connect instance | List |
| ListInstanceStorageConfigs | View storage configurations of an existing Amazon Connect instance | List |
| ListInstances | View the Amazon Connect instances associated with an AWS account | List |
| ListIntegrationAssociations | List summary information about the integration associations for the specified Amazon Connect instance | List |
| ListLambdaFunctions | View the Lambda functions of an existing Amazon Connect instance | List |
| ListLexBots | View the Lex bots of an existing Amazon Connect instance | List |
| ListPhoneNumbers | List phone number resources in an Amazon Connect instance | List |
| ListPhoneNumbersV2 | List phone number resources in an Amazon Connect instance | List |
| ListPredefinedAttributes | List predefined attributes in an Amazon Connect instance | List |
| ListPrompts | List prompt resources in an Amazon Connect instance | List |
| ListQueueQuickConnects | List quick connect resources in a queue in an Amazon Connect instance | List |
| ListQueues | List queue resources in an Amazon Connect instance | List |
| ListQuickConnects | List quick connect resources in an Amazon Connect instance | List |
| ListRealtimeContactAnalysisSegments | List the analysis segments for a real-time analysis session | Read |
| ListRealtimeContactAnalysisSegmentsV2 | List the analysis segments for a real-time chat analytics session | List |
| ListRoutingProfileQueues | List queue resources in a routing profile in an Amazon Connect instance | List |
| ListRoutingProfiles | List routing profile resources in an Amazon Connect instance | List |
| ListRules | List rules associated with a Amazon Connect instance | List |
| ListSecurityKeys | View the security keys of an existing Amazon Connect instance | List |
| ListSecurityProfileApplications | List applications associated with a specific security profile in an Amazon Connect instance | List |
| ListSecurityProfilePermissions | List permissions associated with security profile in an Amazon Connect instance | List |
| ListSecurityProfiles | List security profile resources in an Amazon Connect instance | List |
| ListTagsForResource | List tags for an Amazon Connect resource | Read |
| ListTaskTemplates | List task template resources in an Amazon Connect instance | List |
| ListTrafficDistributionGroupUsers | List the active user associations for a traffic distribution group | List |
| ListTrafficDistributionGroups | List traffic distribution groups | List |
| ListUseCases | List the use cases of an integration association | List |
| ListUserHierarchyGroups | List the hierarchy group resources in an Amazon Connect instance | List |
| ListUserProficiencies | List user proficiencies from a user in an Amazon Connect instance | List |
| ListUsers | List user resources in an Amazon Connect instance | List |
| ListViewVersions | List the view versions in an Amazon Connect instance | List |
| ListViews | List the views in an Amazon Connect instance | List |
| SearchAgentStatuses | Search agent status resources in an Amazon Connect instance | Read |
| SearchAvailablePhoneNumbers | Search phone number resources in an Amazon Connect instance or traffic distribution group | List |
| SearchContactFlowModules | Search contact flow module resources in an Amazon Connect instance | Read |
| SearchContactFlows | Search contact flow resources in an Amazon Connect instance | Read |
| SearchContacts | Search contacts in an Amazon Connect instance | Read |
| SearchEmailAddresses | Search email address resources in an Amazon Connect instance | Read |
| SearchHoursOfOperationOverrides | Search hours of operation override resources in an Amazon Connect instance | Read |
| SearchHoursOfOperations | Search hours of operation resources in an Amazon Connect instance | Read |
| SearchPredefinedAttributes | Search predefined attributes in an Amazon Connect instance | Read |
| SearchPrompts | Search prompt resources in an Amazon Connect instance | Read |
| SearchQueues | Search queue resources in an Amazon Connect instance | Read |
| SearchQuickConnects | Search quick connect resources in an Amazon Connect instance | Read |
| SearchResourceTags | Search tags that are used in an Amazon Connect instance | List |
| SearchRoutingProfiles | Search routing profile resources in an Amazon Connect instance | Read |
| SearchSecurityProfiles | Search security profile resources in an Amazon Connect instance | Read |
| SearchUserHierarchyGroups | Search user hierarchy group resources in an Amazon Connect instance | Read |
| SearchUsers | Search user resources in an Amazon Connect instance | Read |
| SearchVocabularies | Search vocabularies in a Amazon Connect instance | List |
