{"files":{"SKILL.md":"---\nname: amazon-connect-service\ndescription: \"Amazon Connect Service API skill. Use when working with Amazon Connect Service for evaluation-forms, analytics-data, instance. Covers 255 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Amazon Connect Service\nAPI version: 2017-08-08\n\n## Auth\nAWS SigV4\n\n## Base URL\nNot specified.\n\n## Setup\n1. Configure auth: AWS SigV4\n2. GET /instance -- this api is in preview release for amazon connect and is subject to change. return a list of instances which are in active state, creation-in-progress state, and failed state. instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the createinstance api was invoked.\n3. POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate -- create first activate\n\n## Endpoints\n255 endpoints across 66 groups. See references/api-spec.lap for full details.\n\n### Evaluation-forms\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate | Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form. |\n| PUT | /evaluation-forms/{InstanceId} | Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form. |\n| POST | /evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate | Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. |\n| DELETE | /evaluation-forms/{InstanceId}/{EvaluationFormId} | Deletes an evaluation form in the specified Amazon Connect instance.    If the version property is provided, only the specified version of the evaluation form is deleted.   If no version is provided, then the full form (all versions) is deleted. |\n| GET | /evaluation-forms/{InstanceId}/{EvaluationFormId} | Describes 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. |\n| GET | /evaluation-forms/{InstanceId}/{EvaluationFormId}/versions | Lists versions of an evaluation form in the specified Amazon Connect instance. |\n| GET | /evaluation-forms/{InstanceId} | Lists evaluation forms in the specified Amazon Connect instance. |\n| PUT | /evaluation-forms/{InstanceId}/{EvaluationFormId} | Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content. |\n\n### Analytics-data\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /analytics-data/instance/{InstanceId}/association | This API is in preview release for Amazon Connect and is subject to change. Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call. |\n| PUT | /analytics-data/instance/{InstanceId}/associations | This API is in preview release for Amazon Connect and is subject to change. Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call. |\n| POST | /analytics-data/instance/{InstanceId}/associations | This API is in preview release for Amazon Connect and is subject to change. Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call. |\n| POST | /analytics-data/instance/{InstanceId}/association | This API is in preview release for Amazon Connect and is subject to change. Removes the dataset ID associated with a given Amazon Connect instance. |\n| GET | /analytics-data/instance/{InstanceId}/association | This API is in preview release for Amazon Connect and is subject to change. Lists the association status of requested dataset ID for a given Amazon Connect instance. |\n\n### Instance\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /instance/{InstanceId}/approved-origin | This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance. |\n| PUT | /instance/{InstanceId}/bot | This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot. |\n| PUT | /instance/{InstanceId}/storage-config | This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association. |\n| PUT | /instance/{InstanceId}/lambda-function | This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function. |\n| PUT | /instance/{InstanceId}/lex-bot | This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots. |\n| PUT | /instance/{InstanceId}/security-key | This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance. |\n| PUT | /instance | This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.  For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. |\n| PUT | /instance/{InstanceId}/integration-associations | Creates an Amazon Web Services resource association with an Amazon Connect instance. |\n| PUT | /instance/{InstanceId}/task/template | Creates a new task template in the specified Amazon Connect instance. |\n| PUT | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases | Creates a use case for an integration association. |\n| DELETE | /instance/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. |\n| DELETE | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId} | Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it. |\n| DELETE | /instance/{InstanceId}/task/template/{TaskTemplateId} | Deletes the task template. |\n| DELETE | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId} | Deletes a use case from an integration association. |\n| GET | /instance/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.  If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked. |\n| GET | /instance/{InstanceId}/attribute/{AttributeType} | This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute. |\n| GET | /instance/{InstanceId}/storage-config/{AssociationId} | This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID. |\n| DELETE | /instance/{InstanceId}/approved-origin | This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect. |\n| POST | /instance/{InstanceId}/bot | This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. |\n| DELETE | /instance/{InstanceId}/storage-config/{AssociationId} | This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID. |\n| DELETE | /instance/{InstanceId}/lambda-function | This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks. |\n| DELETE | /instance/{InstanceId}/lex-bot | This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot. |\n| DELETE | /instance/{InstanceId}/security-key/{AssociationId} | This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key. |\n| GET | /instance/{InstanceId}/task/template/{TaskTemplateId} | Gets details about a specific task template in the specified Amazon Connect instance. |\n| GET | /instance/{InstanceId}/approved-origins | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance. |\n| GET | /instance/{InstanceId}/bots | This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots. |\n| GET | /instance/{InstanceId}/attributes | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance. |\n| GET | /instance/{InstanceId}/storage-configs | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type. |\n| GET | /instance | This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked. |\n| GET | /instance/{InstanceId}/integration-associations | Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance. |\n| GET | /instance/{InstanceId}/lambda-functions | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks. |\n| GET | /instance/{InstanceId}/lex-bots | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API. |\n| GET | /instance/{InstanceId}/security-keys | This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance. |\n| GET | /instance/{InstanceId}/task/template | Lists task templates for the specified Amazon Connect instance. |\n| GET | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases | Lists the use cases for the integration association. |\n| POST | /instance/{InstanceId}/replicate | Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.  For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide. |\n| POST | /instance/{InstanceId}/attribute/{AttributeType} | This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type. |\n| POST | /instance/{InstanceId}/storage-config/{AssociationId} | This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent. |\n| POST | /instance/{InstanceId}/task/template/{TaskTemplateId} | Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content. |\n\n### Default-vocabulary\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /default-vocabulary/{InstanceId}/{LanguageCode} | Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language. |\n\n### Flow-associations\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /flow-associations/{InstanceId} | Associates a connect resource to a flow. |\n| DELETE | /flow-associations/{InstanceId}/{ResourceId}/{ResourceType} | Disassociates a connect resource from a flow. |\n| GET | /flow-associations/{InstanceId}/{ResourceId}/{ResourceType} | Retrieves the flow associated for a given resource. |\n\n### Phone-number\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /phone-number/{PhoneNumberId}/contact-flow | Associates a flow with a phone number claimed to your Amazon Connect instance.  If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. |\n| POST | /phone-number/claim | Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.   You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.  If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.  For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. |\n| GET | /phone-number/{PhoneNumberId} | Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.  If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. |\n| DELETE | /phone-number/{PhoneNumberId}/contact-flow | Removes the flow association from a phone number claimed to your Amazon Connect instance.  If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException. |\n| POST | /phone-number/import | Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.  Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.   If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.   By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.  For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket. |\n| POST | /phone-number/list | Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.    When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.   When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group. |\n| DELETE | /phone-number/{PhoneNumberId} | Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.  To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.  If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.  For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. |\n| POST | /phone-number/search-available | Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group. |\n| PUT | /phone-number/{PhoneNumberId} | Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.  After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation. |\n| PUT | /phone-number/{PhoneNumberId}/metadata | Updates a phone number’s metadata.  To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API. |\n\n### Queues\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /queues/{InstanceId}/{QueueId}/associate-quick-connects | This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue. |\n| PUT | /queues/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance.    If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.   Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.   If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. |\n| DELETE | /queues/{InstanceId}/{QueueId} | Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website. |\n| GET | /queues/{InstanceId}/{QueueId} | This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue. |\n| POST | /queues/{InstanceId}/{QueueId}/disassociate-quick-connects | This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue. |\n| GET | /queues/{InstanceId}/{QueueId}/quick-connects | This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue. |\n| POST | /queues/{InstanceId}/{QueueId}/hours-of-operation | This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue. |\n| POST | /queues/{InstanceId}/{QueueId}/max-contacts | This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full. |\n| POST | /queues/{InstanceId}/{QueueId}/name | This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a queue. At least Name or Description must be provided. |\n| POST | /queues/{InstanceId}/{QueueId}/outbound-caller-config | This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.    If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.   Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.   If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region. |\n| POST | /queues/{InstanceId}/{QueueId}/status | This API is in preview release for Amazon Connect and is subject to change. Updates the status of the queue. |\n\n### Routing-profiles\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues | Associates a set of queues with a routing profile. |\n| PUT | /routing-profiles/{InstanceId} | Creates a new routing profile. |\n| DELETE | /routing-profiles/{InstanceId}/{RoutingProfileId} | Deletes a routing profile. |\n| GET | /routing-profiles/{InstanceId}/{RoutingProfileId} | Describes the specified routing profile. |\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues | Disassociates a set of queues from a routing profile. |\n| GET | /routing-profiles/{InstanceId}/{RoutingProfileId}/queues | Lists the queues associated with a routing profile. |\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer | Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time. |\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency | Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile. |\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue | Updates the default outbound queue of a routing profile. |\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/name | Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided. |\n| POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/queues | Updates the properties associated with a set of queues for a routing profile. |\n\n### Traffic-distribution-group\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /traffic-distribution-group/{TrafficDistributionGroupId}/user | Associates an agent with a traffic distribution group. |\n| PUT | /traffic-distribution-group | Creates a traffic distribution group given an Amazon Connect instance that has been replicated.   The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.  For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide. |\n| DELETE | /traffic-distribution-group/{TrafficDistributionGroupId} | Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide. |\n| GET | /traffic-distribution-group/{TrafficDistributionGroupId} | Gets details and status of a traffic distribution group. |\n| DELETE | /traffic-distribution-group/{TrafficDistributionGroupId}/user | Disassociates an agent from a traffic distribution group. |\n| GET | /traffic-distribution-group/{TrafficDistributionGroupId}/user | Lists traffic distribution group users. |\n\n### Users\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /users/{InstanceId}/{UserId}/associate-proficiencies | >Associates a set of proficiencies with a user. |\n| PUT | /users/{InstanceId} | Creates a user account for the specified Amazon Connect instance.  Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.  For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide. |\n| DELETE | /users/{InstanceId}/{UserId} | Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.  After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:   Avoid dangling resources that impact your service quotas.   Remove deleted users so they don't appear to agents as transfer options.   Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency. |\n| GET | /users/{InstanceId}/{UserId} | Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output. |\n| POST | /users/{InstanceId}/{UserId}/disassociate-proficiencies | Disassociates a set of proficiencies from a user. |\n| POST | /users/{InstanceId}/{UserId}/contact | Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream. |\n| GET | /users/{InstanceId}/{UserId}/proficiencies | Lists proficiencies associated with a user. |\n| PUT | /users/{InstanceId}/{UserId}/status | Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide. |\n| POST | /users/{InstanceId}/{UserId}/hierarchy | Assigns the specified hierarchy group to the specified user. |\n| POST | /users/{InstanceId}/{UserId}/identity-info | Updates the identity information for the specified user.  We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide. |\n| POST | /users/{InstanceId}/{UserId}/phone-config | Updates the phone configuration settings for the specified user. |\n| POST | /users/{InstanceId}/{UserId}/proficiencies | Updates the properties associated with the proficiencies of a user. |\n| POST | /users/{InstanceId}/{UserId}/routing-profile | Assigns the specified routing profile to the specified user. |\n| POST | /users/{InstanceId}/{UserId}/security-profiles | Assigns the specified security profiles to the specified user. |\n\n### Attached-files\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /attached-files/{InstanceId} | Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn. |\n| POST | /attached-files/{InstanceId}/{FileId} | Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API. |\n| DELETE | /attached-files/{InstanceId}/{FileId} | Deletes an attached file along with the underlying S3 Object.  The attached file is permanently deleted if S3 bucket versioning is not enabled. |\n| GET | /attached-files/{InstanceId}/{FileId} | Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED. |\n| PUT | /attached-files/{InstanceId} | Provides a pre-signed Amazon S3 URL in response for uploading your content.  You may only use this API to upload attachments to an Amazon Connect Case. |\n\n### Flow-associations-batch\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /flow-associations-batch/{InstanceId} | Retrieve the flow associations for the given resources. |\n\n### Contact\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /contact/batch/{InstanceId} | Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.  Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. |\n| POST | /contact/create-participant | Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants. |\n| POST | /contact/persistent-contact-association/{InstanceId}/{InitialContactId} | Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide. |\n| GET | /contact/attributes/{InstanceId}/{InitialContactId} | Retrieves the contact attributes for the specified contact. |\n| GET | /contact/references/{InstanceId}/{ContactId} | This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs. |\n| POST | /contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId} | Provides a list of analysis segments for a real-time analysis session. |\n| POST | /contact/monitor | Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact. |\n| POST | /contact/pause | Allows pausing an ongoing task contact. |\n| POST | /contact/resume | Allows resuming a task contact in a paused state. |\n| POST | /contact/resume-recording | When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported. |\n| PUT | /contact/chat | Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.  A 429 error occurs in the following situations:   API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.   The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.   If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.  For more information about chat, see the following topics in the Amazon Connect Administrator Guide:     Concepts: Web and mobile messaging capabilities in Amazon Connect     Amazon Connect Chat security best practices |\n| POST | /contact/start-recording | Starts recording the contact:    If the API is called before the agent joins the call, recording starts when the agent joins the call.   If the API is called after the agent joins the call, recording starts at the time of the API call.   StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time. |\n| POST | /contact/start-streaming | Initiates real-time message streaming for a new chat contact.  For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide. For more information about chat, see the following topics in the Amazon Connect Administrator Guide:     Concepts: Web and mobile messaging capabilities in Amazon Connect     Amazon Connect Chat security best practices |\n| PUT | /contact/outbound-voice | Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.  UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.    Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns. |\n| PUT | /contact/task | Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.  When using PreviousContactId and RelatedContactId input parameters, note the following:    PreviousContactId    Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.   There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.      RelatedContactId    Copies contact attributes from the related task contact to the new contact.   Any update on attributes in a new task contact does not update attributes on previous contact.   There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.     In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide. |\n| PUT | /contact/webrtc | Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId). |\n| POST | /contact/stop | Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:   DISCONNECT   TRANSFER   QUEUE_TRANSFER   EXTERNAL_OUTBOUND   MONITOR   Chat and task contacts can be terminated in any state, regardless of initiation method. |\n| POST | /contact/stop-recording | Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time. |\n| POST | /contact/stop-streaming | Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API. |\n| POST | /contact/suspend-recording | When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice and screen recordings are supported. |\n| POST | /contact/tags | Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage. |\n| POST | /contact/transfer | Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. Note the following requirements:   Transfer is supported for only TASK contacts.   Do not use both QueueId and UserId in the same call.   The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.   The TransferContact API can be called only on active contacts.   A contact cannot be transferred more than 11 times. |\n| DELETE | /contact/tags/{InstanceId}/{ContactId} | Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage. |\n| POST | /contact/attributes | Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also 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 to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide. |\n| POST | /contact/schedule | Updates the scheduled time of a task contact that is already scheduled. |\n| PUT | /contact/participant-role-config/{InstanceId}/{ContactId} | Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:   Customer idle timeout   Customer auto-disconnect timeout   Agent idle timeout   Agent auto-disconnect timeout   For more information about how chat timeouts work, see Set up chat timeouts for human participants. |\n\n### Agent-status\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /agent-status/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance. |\n| GET | /agent-status/{InstanceId}/{AgentStatusId} | This API is in preview release for Amazon Connect and is subject to change. Describes an agent status. |\n| GET | /agent-status/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses. |\n| POST | /agent-status/{InstanceId}/{AgentStatusId} | This API is in preview release for Amazon Connect and is subject to change. Updates agent status. |\n\n### Contact-flows\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /contact-flows/{InstanceId} | Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. |\n| DELETE | /contact-flows/{InstanceId}/{ContactFlowId} | Deletes a flow for the specified Amazon Connect instance. |\n| GET | /contact-flows/{InstanceId}/{ContactFlowId} | Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED |\n| POST | /contact-flows/{InstanceId}/{ContactFlowId}/content | Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. |\n| POST | /contact-flows/{InstanceId}/{ContactFlowId}/metadata | Updates metadata about specified flow. |\n| POST | /contact-flows/{InstanceId}/{ContactFlowId}/name | The name of the flow. You can also create and update flows using the Amazon Connect Flow language. |\n\n### Contact-flow-modules\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /contact-flow-modules/{InstanceId} | Creates a flow module for the specified Amazon Connect instance. |\n| DELETE | /contact-flow-modules/{InstanceId}/{ContactFlowModuleId} | Deletes the specified flow module. |\n| GET | /contact-flow-modules/{InstanceId}/{ContactFlowModuleId} | Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. |\n| POST | /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content | Updates specified flow module for the specified Amazon Connect instance.  Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. |\n| POST | /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata | Updates metadata about specified flow module. |\n\n### Hours-of-operations\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /hours-of-operations/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation. |\n| DELETE | /hours-of-operations/{InstanceId}/{HoursOfOperationId} | This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation. |\n| GET | /hours-of-operations/{InstanceId}/{HoursOfOperationId} | This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation. |\n| POST | /hours-of-operations/{InstanceId}/{HoursOfOperationId} | This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation. |\n\n### Predefined-attributes\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /predefined-attributes/{InstanceId} | Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. |\n| DELETE | /predefined-attributes/{InstanceId}/{Name} | Deletes a predefined attribute from the specified Amazon Connect instance. |\n| GET | /predefined-attributes/{InstanceId}/{Name} | Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. |\n| GET | /predefined-attributes/{InstanceId} | Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. |\n| POST | /predefined-attributes/{InstanceId}/{Name} | Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. |\n\n### Prompts\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /prompts/{InstanceId} | Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide. |\n| DELETE | /prompts/{InstanceId}/{PromptId} | Deletes a prompt. |\n| GET | /prompts/{InstanceId}/{PromptId} | Describes the prompt. |\n| GET | /prompts/{InstanceId}/{PromptId}/file | Gets the prompt file. |\n| POST | /prompts/{InstanceId}/{PromptId} | Updates a prompt. |\n\n### Quick-connects\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /quick-connects/{InstanceId} | Creates a quick connect for the specified Amazon Connect instance. |\n| DELETE | /quick-connects/{InstanceId}/{QuickConnectId} | Deletes a quick connect.   After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:   Avoid dangling resources that impact your service quotas.   Remove deleted users so they don't appear to agents as transfer options.   Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency. |\n| GET | /quick-connects/{InstanceId}/{QuickConnectId} | Describes the quick connect. |\n| GET | /quick-connects/{InstanceId} | Provides information about the quick connects for the specified Amazon Connect instance. |\n| POST | /quick-connects/{InstanceId}/{QuickConnectId}/config | Updates the configuration settings for the specified quick connect. |\n| POST | /quick-connects/{InstanceId}/{QuickConnectId}/name | Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided. |\n\n### Rules\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /rules/{InstanceId} | Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule. |\n| DELETE | /rules/{InstanceId}/{RuleId} | Deletes a rule for the specified Amazon Connect instance. |\n| GET | /rules/{InstanceId}/{RuleId} | Describes a rule for the specified Amazon Connect instance. |\n| GET | /rules/{InstanceId} | List all rules for the specified Amazon Connect instance. |\n| PUT | /rules/{InstanceId}/{RuleId} | Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule. |\n\n### Security-profiles\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /security-profiles/{InstanceId} | 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. |\n| DELETE | /security-profiles/{InstanceId}/{SecurityProfileId} | Deletes a security profile. |\n| GET | /security-profiles/{InstanceId}/{SecurityProfileId} | Gets basic information about the 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. |\n| POST | /security-profiles/{InstanceId}/{SecurityProfileId} | Updates 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. |\n\n### User-hierarchy-groups\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /user-hierarchy-groups/{InstanceId} | Creates a new user hierarchy group. |\n| DELETE | /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId} | Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups. |\n| GET | /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId} | Describes the specified hierarchy group. |\n| POST | /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name | Updates the name of the user hierarchy group. |\n\n### Views\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /views/{InstanceId} | Creates a new view with the possible status of SAVED or PUBLISHED. The views will have a unique name for each connect instance. It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided. |\n| PUT | /views/{InstanceId}/{ViewId}/versions | Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias. |\n| DELETE | /views/{InstanceId}/{ViewId} | Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases). |\n| DELETE | /views/{InstanceId}/{ViewId}/versions/{ViewVersion} | Deletes the particular version specified in ViewVersion identifier. |\n| GET | /views/{InstanceId}/{ViewId} | Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN.  $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, :$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views. |\n| GET | /views/{InstanceId}/{ViewId}/versions | Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest. |\n| GET | /views/{InstanceId} | Returns views in the given instance. Results are sorted primarily by type, and secondarily by name. |\n| POST | /views/{InstanceId}/{ViewId} | Updates the view content of the given view identifier in the specified Amazon Connect instance. It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED. |\n| POST | /views/{InstanceId}/{ViewId}/metadata | Updates the view metadata. Note that either Name or Description must be provided. |\n\n### Vocabulary\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /vocabulary/{InstanceId} | Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language. |\n| GET | /vocabulary/{InstanceId}/{VocabularyId} | Describes the specified vocabulary. |\n\n### Contact-evaluations\n| Method | Path | Description |\n|--------|------|-------------|\n| DELETE | /contact-evaluations/{InstanceId}/{EvaluationId} | Deletes a contact evaluation in the specified Amazon Connect instance. |\n| GET | /contact-evaluations/{InstanceId}/{EvaluationId} | Describes a contact evaluation in the specified Amazon Connect instance. |\n| GET | /contact-evaluations/{InstanceId} | Lists contact evaluations in the specified Amazon Connect instance. |\n| PUT | /contact-evaluations/{InstanceId} | Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.   Evaluations created through the public API do not contain answer values suggested from automation. |\n| POST | /contact-evaluations/{InstanceId}/{EvaluationId}/submit | Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.  If a contact evaluation is already in submitted state, this operation will trigger a resubmission. |\n| POST | /contact-evaluations/{InstanceId}/{EvaluationId} | Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier. |\n\n### Vocabulary-remove\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /vocabulary-remove/{InstanceId}/{VocabularyId} | Deletes the vocabulary that has the given identifier. |\n\n### Authentication-profiles\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /authentication-profiles/{InstanceId}/{AuthenticationProfileId} | This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile. |\n| POST | /authentication-profiles/{InstanceId}/{AuthenticationProfileId} | This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile. |\n\n### Contacts\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /contacts/{InstanceId}/{ContactId} | This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact.   Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API. |\n| POST | /contacts/{InstanceId}/{ContactId} | This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.  You can add or update user-defined contact information for both ongoing and completed contacts. |\n| POST | /contacts/{InstanceId}/{ContactId}/routing-data | Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.  Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both. |\n\n### User-hierarchy-structure\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /user-hierarchy-structure/{InstanceId} | Describes the hierarchy structure of the specified Amazon Connect instance. |\n| POST | /user-hierarchy-structure/{InstanceId} | Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. |\n\n### Metrics\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /metrics/current/{InstanceId} | Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide. |\n| POST | /metrics/userdata/{InstanceId} | Gets the real-time active user data from the specified Amazon Connect instance. |\n| POST | /metrics/historical/{InstanceId} | Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.  We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week. |\n| POST | /metrics/data | Gets metric data from the specified Amazon Connect instance.   GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.  For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide. |\n\n### User\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /user/federate/{InstanceId} | Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.  For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.   This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:   Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect |\n\n### Traffic-distribution\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /traffic-distribution/{Id} | Retrieves the current traffic distribution for a given traffic distribution group. |\n| PUT | /traffic-distribution/{Id} | Updates the traffic distribution for a given traffic distribution group.   The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.  For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions  in the Amazon Connect Administrator Guide. |\n\n### Authentication-profiles-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /authentication-profiles-summary/{InstanceId} | This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance. |\n\n### Contact-flow-modules-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /contact-flow-modules-summary/{InstanceId} | Provides information about the flow modules for the specified Amazon Connect instance. |\n\n### Contact-flows-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /contact-flows-summary/{InstanceId} | Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide. |\n\n### Default-vocabulary-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /default-vocabulary-summary/{InstanceId} | Lists the default vocabularies for the specified Amazon Connect instance. |\n\n### Flow-associations-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /flow-associations-summary/{InstanceId} | List the flow association based on the filters. |\n\n### Hours-of-operations-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /hours-of-operations-summary/{InstanceId} | Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide. |\n\n### Phone-numbers-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /phone-numbers-summary/{InstanceId} | Provides information about the phone numbers for the specified Amazon Connect instance.  For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.    We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.    The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources. |\n\n### Prompts-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /prompts-summary/{InstanceId} | Provides information about the prompts for the specified Amazon Connect instance. |\n\n### Queues-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /queues-summary/{InstanceId} | Provides information about the queues for the specified Amazon Connect instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide. |\n\n### Routing-profiles-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /routing-profiles-summary/{InstanceId} | Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide. |\n\n### Security-profiles-applications\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /security-profiles-applications/{InstanceId}/{SecurityProfileId} | Returns a list of third-party applications in a specific security profile. |\n\n### Security-profiles-permissions\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /security-profiles-permissions/{InstanceId}/{SecurityProfileId} | Lists the permissions granted to 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. |\n\n### Security-profiles-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /security-profiles-summary/{InstanceId} | Provides summary information about the security profiles for the specified Amazon Connect instance. For more 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. |\n\n### Tags\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /tags/{resourceArn} | Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide. |\n| POST | /tags/{resourceArn} | Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide. |\n| DELETE | /tags/{resourceArn} | Removes the specified tags from the specified resource. |\n\n### Traffic-distribution-groups\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /traffic-distribution-groups | Lists traffic distribution groups. |\n\n### User-hierarchy-groups-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /user-hierarchy-groups-summary/{InstanceId} | Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide. |\n\n### Users-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /users-summary/{InstanceId} | Provides summary information about the users for the specified Amazon Connect instance. |\n\n### Search-agent-statuses\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-agent-statuses | Searches AgentStatuses in an Amazon Connect instance, with optional filtering. |\n\n### Search-contact-flow-modules\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-contact-flow-modules | Searches the flow modules in an Amazon Connect instance, with optional filtering. |\n\n### Search-contact-flows\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-contact-flows | Searches the contact flows in an Amazon Connect instance, with optional filtering. |\n\n### Search-contacts\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-contacts | Searches contacts in an Amazon Connect instance. |\n\n### Search-hours-of-operations\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-hours-of-operations | Searches the hours of operation in an Amazon Connect instance, with optional filtering. |\n\n### Search-predefined-attributes\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-predefined-attributes | Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents. |\n\n### Search-prompts\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-prompts | Searches prompts in an Amazon Connect instance, with optional filtering. |\n\n### Search-queues\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-queues | Searches queues in an Amazon Connect instance, with optional filtering. |\n\n### Search-quick-connects\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-quick-connects | Searches quick connects in an Amazon Connect instance, with optional filtering. |\n\n### Search-resource-tags\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-resource-tags | Searches tags used in an Amazon Connect instance using optional search criteria. |\n\n### Search-routing-profiles\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-routing-profiles | Searches routing profiles in an Amazon Connect instance, with optional filtering. |\n\n### Search-security-profiles\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-security-profiles | Searches security profiles in an Amazon Connect instance, with optional filtering. 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. |\n\n### Search-user-hierarchy-groups\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-user-hierarchy-groups | Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.  The UserHierarchyGroup with \"LevelId\": \"0\" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI. |\n\n### Search-users\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /search-users | Searches users in an Amazon Connect instance, with optional filtering.    AfterContactWorkTimeLimit is returned in milliseconds. |\n\n### Vocabulary-summary\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /vocabulary-summary/{InstanceId} | Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode. |\n\n### Chat-integration-event\n| Method | Path | Description |\n|--------|------|-------------|\n| POST | /chat-integration-event | Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:   SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat    ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat   When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.  Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Create a activate?\" -> POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate\n- \"Update a default-vocabulary?\" -> PUT /default-vocabulary/{InstanceId}/{LanguageCode}\n- \"Update a flow-association?\" -> PUT /flow-associations/{InstanceId}\n- \"Create a associate-quick-connect?\" -> POST /queues/{InstanceId}/{QueueId}/associate-quick-connects\n- \"Create a associate-queue?\" -> POST /routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues\n- \"Create a associate-proficiency?\" -> POST /users/{InstanceId}/{UserId}/associate-proficiencies\n- \"Create a association?\" -> POST /analytics-data/instance/{InstanceId}/associations\n- \"Update a batch?\" -> PUT /contact/batch/{InstanceId}\n- \"Create a claim?\" -> POST /phone-number/claim\n- \"Update a agent-status?\" -> PUT /agent-status/{InstanceId}\n- \"Update a contact-flow?\" -> PUT /contact-flows/{InstanceId}\n- \"Update a contact-flow-module?\" -> PUT /contact-flow-modules/{InstanceId}\n- \"Update a evaluation-form?\" -> PUT /evaluation-forms/{InstanceId}\n- \"Update a hours-of-operation?\" -> PUT /hours-of-operations/{InstanceId}\n- \"Create a create-participant?\" -> POST /contact/create-participant\n- \"Update a predefined-attribute?\" -> PUT /predefined-attributes/{InstanceId}\n- \"Update a prompt?\" -> PUT /prompts/{InstanceId}\n- \"Update a queue?\" -> PUT /queues/{InstanceId}\n- \"Update a quick-connect?\" -> PUT /quick-connects/{InstanceId}\n- \"Update a routing-profile?\" -> PUT /routing-profiles/{InstanceId}\n- \"Update a security-profile?\" -> PUT /security-profiles/{InstanceId}\n- \"Update a user?\" -> PUT /users/{InstanceId}\n- \"Update a user-hierarchy-group?\" -> PUT /user-hierarchy-groups/{InstanceId}\n- \"Update a view?\" -> PUT /views/{InstanceId}\n- \"Create a deactivate?\" -> POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate\n- \"Delete a attached-file?\" -> DELETE /attached-files/{InstanceId}/{FileId}\n- \"Delete a contact-evaluation?\" -> DELETE /contact-evaluations/{InstanceId}/{EvaluationId}\n- \"Delete a contact-flow?\" -> DELETE /contact-flows/{InstanceId}/{ContactFlowId}\n- \"Delete a contact-flow-module?\" -> DELETE /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}\n- \"Delete a evaluation-form?\" -> DELETE /evaluation-forms/{InstanceId}/{EvaluationFormId}\n- \"Delete a hours-of-operation?\" -> DELETE /hours-of-operations/{InstanceId}/{HoursOfOperationId}\n- \"Delete a instance?\" -> DELETE /instance/{InstanceId}\n- \"Delete a integration-association?\" -> DELETE /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}\n- \"Delete a predefined-attribute?\" -> DELETE /predefined-attributes/{InstanceId}/{Name}\n- \"Delete a prompt?\" -> DELETE /prompts/{InstanceId}/{PromptId}\n- \"Delete a queue?\" -> DELETE /queues/{InstanceId}/{QueueId}\n- \"Delete a quick-connect?\" -> DELETE /quick-connects/{InstanceId}/{QuickConnectId}\n- \"Delete a routing-profile?\" -> DELETE /routing-profiles/{InstanceId}/{RoutingProfileId}\n- \"Delete a rule?\" -> DELETE /rules/{InstanceId}/{RuleId}\n- \"Delete a security-profile?\" -> DELETE /security-profiles/{InstanceId}/{SecurityProfileId}\n- \"Delete a template?\" -> DELETE /instance/{InstanceId}/task/template/{TaskTemplateId}\n- \"Delete a traffic-distribution-group?\" -> DELETE /traffic-distribution-group/{TrafficDistributionGroupId}\n- \"Delete a use-case?\" -> DELETE /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}\n- \"Delete a user?\" -> DELETE /users/{InstanceId}/{UserId}\n- \"Delete a user-hierarchy-group?\" -> DELETE /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}\n- \"Delete a view?\" -> DELETE /views/{InstanceId}/{ViewId}\n- \"Delete a version?\" -> DELETE /views/{InstanceId}/{ViewId}/versions/{ViewVersion}\n- \"Get agent-status details?\" -> GET /agent-status/{InstanceId}/{AgentStatusId}\n- \"Get authentication-profile details?\" -> GET /authentication-profiles/{InstanceId}/{AuthenticationProfileId}\n- \"Get contact details?\" -> GET /contacts/{InstanceId}/{ContactId}\n- \"Get contact-evaluation details?\" -> GET /contact-evaluations/{InstanceId}/{EvaluationId}\n- \"Get contact-flow details?\" -> GET /contact-flows/{InstanceId}/{ContactFlowId}\n- \"Get contact-flow-module details?\" -> GET /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}\n- \"Get evaluation-form details?\" -> GET /evaluation-forms/{InstanceId}/{EvaluationFormId}\n- \"Get hours-of-operation details?\" -> GET /hours-of-operations/{InstanceId}/{HoursOfOperationId}\n- \"Get instance details?\" -> GET /instance/{InstanceId}\n- \"Get attribute details?\" -> GET /instance/{InstanceId}/attribute/{AttributeType}\n- \"Get storage-config details?\" -> GET /instance/{InstanceId}/storage-config/{AssociationId}\n- \"Get phone-number details?\" -> GET /phone-number/{PhoneNumberId}\n- \"Get predefined-attribute details?\" -> GET /predefined-attributes/{InstanceId}/{Name}\n- \"Get prompt details?\" -> GET /prompts/{InstanceId}/{PromptId}\n- \"Get queue details?\" -> GET /queues/{InstanceId}/{QueueId}\n- \"Get quick-connect details?\" -> GET /quick-connects/{InstanceId}/{QuickConnectId}\n- \"Get routing-profile details?\" -> GET /routing-profiles/{InstanceId}/{RoutingProfileId}\n- \"Get rule details?\" -> GET /rules/{InstanceId}/{RuleId}\n- \"Get security-profile details?\" -> GET /security-profiles/{InstanceId}/{SecurityProfileId}\n- \"Get traffic-distribution-group details?\" -> GET /traffic-distribution-group/{TrafficDistributionGroupId}\n- \"Get user details?\" -> GET /users/{InstanceId}/{UserId}\n- \"Get user-hierarchy-group details?\" -> GET /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}\n- \"Get user-hierarchy-structure details?\" -> GET /user-hierarchy-structure/{InstanceId}\n- \"Get view details?\" -> GET /views/{InstanceId}/{ViewId}\n- \"Get vocabulary details?\" -> GET /vocabulary/{InstanceId}/{VocabularyId}\n- \"Create a bot?\" -> POST /instance/{InstanceId}/bot\n- \"Delete a flow-association?\" -> DELETE /flow-associations/{InstanceId}/{ResourceId}/{ResourceType}\n- \"Delete a storage-config?\" -> DELETE /instance/{InstanceId}/storage-config/{AssociationId}\n- \"Create a disassociate-quick-connect?\" -> POST /queues/{InstanceId}/{QueueId}/disassociate-quick-connects\n- \"Create a disassociate-queue?\" -> POST /routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues\n- \"Delete a security-key?\" -> DELETE /instance/{InstanceId}/security-key/{AssociationId}\n- \"Create a disassociate-proficiency?\" -> POST /users/{InstanceId}/{UserId}/disassociate-proficiencies\n- \"Create a contact?\" -> POST /users/{InstanceId}/{UserId}/contact\n- \"Get attached-file details?\" -> GET /attached-files/{InstanceId}/{FileId}\n- \"Get federate details?\" -> GET /user/federate/{InstanceId}\n- \"Get flow-association details?\" -> GET /flow-associations/{InstanceId}/{ResourceId}/{ResourceType}\n- \"Create a data?\" -> POST /metrics/data\n- \"List all file?\" -> GET /prompts/{InstanceId}/{PromptId}/file\n- \"Get template details?\" -> GET /instance/{InstanceId}/task/template/{TaskTemplateId}\n- \"Get traffic-distribution details?\" -> GET /traffic-distribution/{Id}\n- \"Create a import?\" -> POST /phone-number/import\n- \"List all association?\" -> GET /analytics-data/instance/{InstanceId}/association\n- \"List all approved-origins?\" -> GET /instance/{InstanceId}/approved-origins\n- \"Get authentication-profiles-summary details?\" -> GET /authentication-profiles-summary/{InstanceId}\n- \"List all bots?\" -> GET /instance/{InstanceId}/bots\n- \"Get contact-flow-modules-summary details?\" -> GET /contact-flow-modules-summary/{InstanceId}\n- \"Get contact-flows-summary details?\" -> GET /contact-flows-summary/{InstanceId}\n- \"Get reference details?\" -> GET /contact/references/{InstanceId}/{ContactId}\n- \"List all versions?\" -> GET /evaluation-forms/{InstanceId}/{EvaluationFormId}/versions\n- \"Get flow-associations-summary details?\" -> GET /flow-associations-summary/{InstanceId}\n- \"Get hours-of-operations-summary details?\" -> GET /hours-of-operations-summary/{InstanceId}\n- \"List all attributes?\" -> GET /instance/{InstanceId}/attributes\n- \"List all storage-configs?\" -> GET /instance/{InstanceId}/storage-configs\n- \"List all instance?\" -> GET /instance\n- \"List all integration-associations?\" -> GET /instance/{InstanceId}/integration-associations\n- \"List all lambda-functions?\" -> GET /instance/{InstanceId}/lambda-functions\n- \"List all lex-bots?\" -> GET /instance/{InstanceId}/lex-bots\n- \"Get phone-numbers-summary details?\" -> GET /phone-numbers-summary/{InstanceId}\n- \"Create a list?\" -> POST /phone-number/list\n- \"Get prompts-summary details?\" -> GET /prompts-summary/{InstanceId}\n- \"List all quick-connects?\" -> GET /queues/{InstanceId}/{QueueId}/quick-connects\n- \"Get queues-summary details?\" -> GET /queues-summary/{InstanceId}\n- \"List all queues?\" -> GET /routing-profiles/{InstanceId}/{RoutingProfileId}/queues\n- \"Get routing-profiles-summary details?\" -> GET /routing-profiles-summary/{InstanceId}\n- \"List all security-keys?\" -> GET /instance/{InstanceId}/security-keys\n- \"Get security-profiles-application details?\" -> GET /security-profiles-applications/{InstanceId}/{SecurityProfileId}\n- \"Get security-profiles-permission details?\" -> GET /security-profiles-permissions/{InstanceId}/{SecurityProfileId}\n- \"Get security-profiles-summary details?\" -> GET /security-profiles-summary/{InstanceId}\n- \"Get tag details?\" -> GET /tags/{resourceArn}\n- \"List all template?\" -> GET /instance/{InstanceId}/task/template\n- \"List all user?\" -> GET /traffic-distribution-group/{TrafficDistributionGroupId}/user\n- \"List all traffic-distribution-groups?\" -> GET /traffic-distribution-groups\n- \"List all use-cases?\" -> GET /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases\n- \"Get user-hierarchy-groups-summary details?\" -> GET /user-hierarchy-groups-summary/{InstanceId}\n- \"List all proficiencies?\" -> GET /users/{InstanceId}/{UserId}/proficiencies\n- \"Get users-summary details?\" -> GET /users-summary/{InstanceId}\n- \"Create a monitor?\" -> POST /contact/monitor\n- \"Create a pause?\" -> POST /contact/pause\n- \"Delete a phone-number?\" -> DELETE /phone-number/{PhoneNumberId}\n- \"Create a replicate?\" -> POST /instance/{InstanceId}/replicate\n- \"Create a resume?\" -> POST /contact/resume\n- \"Create a resume-recording?\" -> POST /contact/resume-recording\n- \"Create a search-agent-statuse?\" -> POST /search-agent-statuses\n- \"Create a search-available?\" -> POST /phone-number/search-available\n- \"Create a search-contact-flow-module?\" -> POST /search-contact-flow-modules\n- \"Create a search-contact-flow?\" -> POST /search-contact-flows\n- \"Create a search-contact?\" -> POST /search-contacts\n- \"Create a search-hours-of-operation?\" -> POST /search-hours-of-operations\n- \"Create a search-predefined-attribute?\" -> POST /search-predefined-attributes\n- \"Create a search-prompt?\" -> POST /search-prompts\n- \"Create a search-queue?\" -> POST /search-queues\n- \"Create a search-quick-connect?\" -> POST /search-quick-connects\n- \"Create a search-resource-tag?\" -> POST /search-resource-tags\n- \"Create a search-routing-profile?\" -> POST /search-routing-profiles\n- \"Create a search-security-profile?\" -> POST /search-security-profiles\n- \"Create a search-user-hierarchy-group?\" -> POST /search-user-hierarchy-groups\n- \"Create a search-user?\" -> POST /search-users\n- \"Create a chat-integration-event?\" -> POST /chat-integration-event\n- \"Update a attached-file?\" -> PUT /attached-files/{InstanceId}\n- \"Update a contact-evaluation?\" -> PUT /contact-evaluations/{InstanceId}\n- \"Create a start-recording?\" -> POST /contact/start-recording\n- \"Create a start-streaming?\" -> POST /contact/start-streaming\n- \"Create a stop?\" -> POST /contact/stop\n- \"Create a stop-recording?\" -> POST /contact/stop-recording\n- \"Create a stop-streaming?\" -> POST /contact/stop-streaming\n- \"Create a submit?\" -> POST /contact-evaluations/{InstanceId}/{EvaluationId}/submit\n- \"Create a suspend-recording?\" -> POST /contact/suspend-recording\n- \"Create a tag?\" -> POST /contact/tags\n- \"Create a transfer?\" -> POST /contact/transfer\n- \"Delete a tag?\" -> DELETE /contact/tags/{InstanceId}/{ContactId}\n- \"Create a attribute?\" -> POST /contact/attributes\n- \"Create a content?\" -> POST /contact-flows/{InstanceId}/{ContactFlowId}/content\n- \"Create a metadata?\" -> POST /contact-flows/{InstanceId}/{ContactFlowId}/metadata\n- \"Create a name?\" -> POST /contact-flows/{InstanceId}/{ContactFlowId}/name\n- \"Create a routing-data?\" -> POST /contacts/{InstanceId}/{ContactId}/routing-data\n- \"Create a schedule?\" -> POST /contact/schedule\n- \"Update a participant-role-config?\" -> PUT /contact/participant-role-config/{InstanceId}/{ContactId}\n- \"Update a phone-number?\" -> PUT /phone-number/{PhoneNumberId}\n- \"Create a hours-of-operation?\" -> POST /queues/{InstanceId}/{QueueId}/hours-of-operation\n- \"Create a max-contact?\" -> POST /queues/{InstanceId}/{QueueId}/max-contacts\n- \"Create a outbound-caller-config?\" -> POST /queues/{InstanceId}/{QueueId}/outbound-caller-config\n- \"Create a status?\" -> POST /queues/{InstanceId}/{QueueId}/status\n- \"Create a config?\" -> POST /quick-connects/{InstanceId}/{QuickConnectId}/config\n- \"Create a agent-availability-timer?\" -> POST /routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer\n- \"Create a concurrency?\" -> POST /routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency\n- \"Create a default-outbound-queue?\" -> POST /routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue\n- \"Create a queue?\" -> POST /routing-profiles/{InstanceId}/{RoutingProfileId}/queues\n- \"Update a rule?\" -> PUT /rules/{InstanceId}/{RuleId}\n- \"Update a traffic-distribution?\" -> PUT /traffic-distribution/{Id}\n- \"Create a hierarchy?\" -> POST /users/{InstanceId}/{UserId}/hierarchy\n- \"Create a identity-info?\" -> POST /users/{InstanceId}/{UserId}/identity-info\n- \"Create a phone-config?\" -> POST /users/{InstanceId}/{UserId}/phone-config\n- \"Create a proficiency?\" -> POST /users/{InstanceId}/{UserId}/proficiencies\n- \"Create a routing-profile?\" -> POST /users/{InstanceId}/{UserId}/routing-profile\n- \"Create a security-profile?\" -> POST /users/{InstanceId}/{UserId}/security-profiles\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Amazon Connect Service\n@version 2017-08-08\n@auth AWS SigV4\n@endpoints 255\n@hint download_for_search\n@toc evaluation-forms(8), analytics-data(5), instance(39), default-vocabulary(1), flow-associations(3), phone-number(10), queues(11), routing-profiles(11), traffic-distribution-group(6), users(14), attached-files(5), flow-associations-batch(1), contact(26), agent-status(4), contact-flows(6), contact-flow-modules(5), hours-of-operations(4), predefined-attributes(5), prompts(5), quick-connects(6), rules(5), security-profiles(4), user-hierarchy-groups(4), views(9), vocabulary(2), contact-evaluations(6), vocabulary-remove(1), authentication-profiles(2), contacts(3), user-hierarchy-structure(2), metrics(4), user(1), traffic-distribution(2), authentication-profiles-summary(1), contact-flow-modules-summary(1), contact-flows-summary(1), default-vocabulary-summary(1), flow-associations-summary(1), hours-of-operations-summary(1), phone-numbers-summary(1), prompts-summary(1), queues-summary(1), routing-profiles-summary(1), security-profiles-applications(1), security-profiles-permissions(1), security-profiles-summary(1), tags(3), traffic-distribution-groups(1), user-hierarchy-groups-summary(1), users-summary(1), search-agent-statuses(1), search-contact-flow-modules(1), search-contact-flows(1), search-contacts(1), search-hours-of-operations(1), search-predefined-attributes(1), search-prompts(1), search-queues(1), search-quick-connects(1), search-resource-tags(1), search-routing-profiles(1), search-security-profiles(1), search-user-hierarchy-groups(1), search-users(1), vocabulary-summary(1), chat-integration-event(1)\n\n@group evaluation-forms\n@endpoint POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate\n@desc Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.\n@required {InstanceId: str, EvaluationFormId: str, EvaluationFormVersion: int}\n@returns(200) {EvaluationFormId: str, EvaluationFormArn: str, EvaluationFormVersion: int}\n\n@endgroup\n\n@group analytics-data\n@endpoint PUT /analytics-data/instance/{InstanceId}/association\n@desc This API is in preview release for Amazon Connect and is subject to change. Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.\n@required {InstanceId: str, DataSetId: str}\n@optional {TargetAccountId: str}\n@returns(200) {DataSetId: str?, TargetAccountId: str?, ResourceShareId: str?, ResourceShareArn: str?}\n\n@endgroup\n\n@group instance\n@endpoint PUT /instance/{InstanceId}/approved-origin\n@desc This API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance.\n@required {InstanceId: str, Origin: str}\n\n@endpoint PUT /instance/{InstanceId}/bot\n@desc This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.\n@required {InstanceId: str}\n@optional {LexBot: LexBot, LexV2Bot: LexV2Bot}\n\n@endgroup\n\n@group default-vocabulary\n@endpoint PUT /default-vocabulary/{InstanceId}/{LanguageCode}\n@desc Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.\n@required {InstanceId: str, LanguageCode: str}\n@optional {VocabularyId: str}\n\n@endgroup\n\n@group flow-associations\n@endpoint PUT /flow-associations/{InstanceId}\n@desc Associates a connect resource to a flow.\n@required {InstanceId: str, ResourceId: str, FlowId: str, ResourceType: str}\n\n@endgroup\n\n@group instance\n@endpoint PUT /instance/{InstanceId}/storage-config\n@desc This API is in preview release for Amazon Connect and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.\n@required {InstanceId: str, ResourceType: str, StorageConfig: InstanceStorageConfig}\n@returns(200) {AssociationId: str?}\n\n@endpoint PUT /instance/{InstanceId}/lambda-function\n@desc This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Lambda function.\n@required {InstanceId: str, FunctionArn: str}\n\n@endpoint PUT /instance/{InstanceId}/lex-bot\n@desc This API is in preview release for Amazon Connect and is subject to change. Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.\n@required {InstanceId: str, LexBot: LexBot}\n\n@endgroup\n\n@group phone-number\n@endpoint PUT /phone-number/{PhoneNumberId}/contact-flow\n@desc Associates a flow with a phone number claimed to your Amazon Connect instance.  If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.\n@required {PhoneNumberId: str, InstanceId: str, ContactFlowId: str}\n\n@endgroup\n\n@group queues\n@endpoint POST /queues/{InstanceId}/{QueueId}/associate-quick-connects\n@desc This API is in preview release for Amazon Connect and is subject to change. Associates a set of quick connects with a queue.\n@required {InstanceId: str, QueueId: str, QuickConnectIds: [str]}\n\n@endgroup\n\n@group routing-profiles\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues\n@desc Associates a set of queues with a routing profile.\n@required {InstanceId: str, RoutingProfileId: str, QueueConfigs: [RoutingProfileQueueConfig]}\n\n@endgroup\n\n@group instance\n@endpoint PUT /instance/{InstanceId}/security-key\n@desc This API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.\n@required {InstanceId: str, Key: str}\n@returns(200) {AssociationId: str?}\n\n@endgroup\n\n@group traffic-distribution-group\n@endpoint PUT /traffic-distribution-group/{TrafficDistributionGroupId}/user\n@desc Associates an agent with a traffic distribution group.\n@required {TrafficDistributionGroupId: str, UserId: str, InstanceId: str}\n\n@endgroup\n\n@group users\n@endpoint POST /users/{InstanceId}/{UserId}/associate-proficiencies\n@desc >Associates a set of proficiencies with a user.\n@required {InstanceId: str, UserId: str, UserProficiencies: [UserProficiency]}\n\n@endgroup\n\n@group analytics-data\n@endpoint PUT /analytics-data/instance/{InstanceId}/associations\n@desc This API is in preview release for Amazon Connect and is subject to change. Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.\n@required {InstanceId: str, DataSetIds: [str]}\n@optional {TargetAccountId: str}\n@returns(200) {Created: [AnalyticsDataAssociationResult]?, Errors: [ErrorResult]?}\n\n@endpoint POST /analytics-data/instance/{InstanceId}/associations\n@desc This API is in preview release for Amazon Connect and is subject to change. Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.\n@required {InstanceId: str, DataSetIds: [str]}\n@optional {TargetAccountId: str}\n@returns(200) {Deleted: [str]?, Errors: [ErrorResult]?}\n\n@endgroup\n\n@group attached-files\n@endpoint POST /attached-files/{InstanceId}\n@desc Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.\n@required {InstanceId: str, associatedResourceArn: str, FileIds: [str]}\n@returns(200) {Files: [AttachedFile]?, Errors: [AttachedFileError]?}\n\n@endgroup\n\n@group flow-associations-batch\n@endpoint POST /flow-associations-batch/{InstanceId}\n@desc Retrieve the flow associations for the given resources.\n@required {InstanceId: str, ResourceIds: [str]}\n@optional {ResourceType: str}\n@returns(200) {FlowAssociationSummaryList: [FlowAssociationSummary]?}\n\n@endgroup\n\n@group contact\n@endpoint PUT /contact/batch/{InstanceId}\n@desc Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.  Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.\n@required {InstanceId: str, ContactDataRequestList: [ContactDataRequest]}\n@optional {ClientToken: str}\n@returns(200) {SuccessfulRequestList: [SuccessfulRequest]?, FailedRequestList: [FailedRequest]?}\n\n@endgroup\n\n@group phone-number\n@endpoint POST /phone-number/claim\n@desc Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.   You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.  If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.  For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.\n@required {PhoneNumber: str}\n@optional {TargetArn: str, InstanceId: str, PhoneNumberDescription: str, Tags: map<str,str>, ClientToken: str}\n@returns(200) {PhoneNumberId: str?, PhoneNumberArn: str?}\n\n@endgroup\n\n@group attached-files\n@endpoint POST /attached-files/{InstanceId}/{FileId}\n@desc Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.\n@required {InstanceId: str, FileId: str, associatedResourceArn: str}\n\n@endgroup\n\n@group agent-status\n@endpoint PUT /agent-status/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance.\n@required {InstanceId: str, Name: str, State: str}\n@optional {Description: str, DisplayOrder: int, Tags: map<str,str>}\n@returns(200) {AgentStatusARN: str?, AgentStatusId: str?}\n\n@endgroup\n\n@group contact-flows\n@endpoint PUT /contact-flows/{InstanceId}\n@desc Creates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language.\n@required {InstanceId: str, Name: str, Type: str, Content: str}\n@optional {Description: str, Status: str, Tags: map<str,str>}\n@returns(200) {ContactFlowId: str?, ContactFlowArn: str?}\n\n@endgroup\n\n@group contact-flow-modules\n@endpoint PUT /contact-flow-modules/{InstanceId}\n@desc Creates a flow module for the specified Amazon Connect instance.\n@required {InstanceId: str, Name: str, Content: str}\n@optional {Description: str, Tags: map<str,str>, ClientToken: str}\n@returns(200) {Id: str?, Arn: str?}\n\n@endgroup\n\n@group evaluation-forms\n@endpoint PUT /evaluation-forms/{InstanceId}\n@desc Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.\n@required {InstanceId: str, Title: str, Items: [EvaluationFormItem]}\n@optional {Description: str, ScoringStrategy: EvaluationFormScoringStrategy, ClientToken: str}\n@returns(200) {EvaluationFormId: str, EvaluationFormArn: str}\n\n@endgroup\n\n@group hours-of-operations\n@endpoint PUT /hours-of-operations/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Creates hours of operation.\n@required {InstanceId: str, Name: str, TimeZone: str, Config: [HoursOfOperationConfig]}\n@optional {Description: str, Tags: map<str,str>}\n@returns(200) {HoursOfOperationId: str?, HoursOfOperationArn: str?}\n\n@endgroup\n\n@group instance\n@endpoint PUT /instance\n@desc This API is in preview release for Amazon Connect and is subject to change. Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.  For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.\n@required {IdentityManagementType: str, InboundCallsEnabled: bool, OutboundCallsEnabled: bool}\n@optional {ClientToken: str, InstanceAlias: str, DirectoryId: str, Tags: map<str,str>}\n@returns(200) {Id: str?, Arn: str?}\n\n@endpoint PUT /instance/{InstanceId}/integration-associations\n@desc Creates an Amazon Web Services resource association with an Amazon Connect instance.\n@required {InstanceId: str, IntegrationType: str, IntegrationArn: str}\n@optional {SourceApplicationUrl: str, SourceApplicationName: str, SourceType: str, Tags: map<str,str>}\n@returns(200) {IntegrationAssociationId: str?, IntegrationAssociationArn: str?}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/create-participant\n@desc Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.\n@required {InstanceId: str, ContactId: str, ParticipantDetails: ParticipantDetailsToAdd}\n@optional {ClientToken: str}\n@returns(200) {ParticipantCredentials: ParticipantTokenCredentials?{ParticipantToken: str?, Expiry: str?}, ParticipantId: str?}\n\n@endpoint POST /contact/persistent-contact-association/{InstanceId}/{InitialContactId}\n@desc Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.\n@required {InstanceId: str, InitialContactId: str, RehydrationType: str, SourceContactId: str}\n@optional {ClientToken: str}\n@returns(200) {ContinuedFromContactId: str?}\n\n@endgroup\n\n@group predefined-attributes\n@endpoint PUT /predefined-attributes/{InstanceId}\n@desc Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.\n@required {InstanceId: str, Name: str, Values: PredefinedAttributeValues}\n\n@endgroup\n\n@group prompts\n@endpoint PUT /prompts/{InstanceId}\n@desc Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.\n@required {InstanceId: str, Name: str, S3Uri: str}\n@optional {Description: str, Tags: map<str,str>}\n@returns(200) {PromptARN: str?, PromptId: str?}\n\n@endgroup\n\n@group queues\n@endpoint PUT /queues/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Creates a new queue for the specified Amazon Connect instance.    If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.   Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.   If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.\n@required {InstanceId: str, Name: str, HoursOfOperationId: str}\n@optional {Description: str, OutboundCallerConfig: OutboundCallerConfig, MaxContacts: int, QuickConnectIds: [str], Tags: map<str,str>}\n@returns(200) {QueueArn: str?, QueueId: str?}\n\n@endgroup\n\n@group quick-connects\n@endpoint PUT /quick-connects/{InstanceId}\n@desc Creates a quick connect for the specified Amazon Connect instance.\n@required {InstanceId: str, Name: str, QuickConnectConfig: QuickConnectConfig}\n@optional {Description: str, Tags: map<str,str>}\n@returns(200) {QuickConnectARN: str?, QuickConnectId: str?}\n\n@endgroup\n\n@group routing-profiles\n@endpoint PUT /routing-profiles/{InstanceId}\n@desc Creates a new routing profile.\n@required {InstanceId: str, Name: str, Description: str, DefaultOutboundQueueId: str, MediaConcurrencies: [MediaConcurrency]}\n@optional {QueueConfigs: [RoutingProfileQueueConfig], Tags: map<str,str>, AgentAvailabilityTimer: str}\n@returns(200) {RoutingProfileArn: str?, RoutingProfileId: str?}\n\n@endgroup\n\n@group rules\n@endpoint POST /rules/{InstanceId}\n@desc Creates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.\n@required {InstanceId: str, Name: str, TriggerEventSource: RuleTriggerEventSource, Function: str, Actions: [RuleAction], PublishStatus: str}\n@optional {ClientToken: str}\n@returns(200) {RuleArn: str, RuleId: str}\n\n@endgroup\n\n@group security-profiles\n@endpoint PUT /security-profiles/{InstanceId}\n@desc 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.\n@required {InstanceId: str, SecurityProfileName: str}\n@optional {Description: str, Permissions: [str], Tags: map<str,str>, AllowedAccessControlTags: map<str,str>, TagRestrictedResources: [str], Applications: [Application], HierarchyRestrictedResources: [str], AllowedAccessControlHierarchyGroupId: str}\n@returns(200) {SecurityProfileId: str?, SecurityProfileArn: str?}\n\n@endgroup\n\n@group instance\n@endpoint PUT /instance/{InstanceId}/task/template\n@desc Creates a new task template in the specified Amazon Connect instance.\n@required {InstanceId: str, Name: str, Fields: [TaskTemplateField]}\n@optional {Description: str, ContactFlowId: str, Constraints: TaskTemplateConstraints, Defaults: TaskTemplateDefaults, Status: str, ClientToken: str}\n@returns(200) {Id: str, Arn: str}\n\n@endgroup\n\n@group traffic-distribution-group\n@endpoint PUT /traffic-distribution-group\n@desc Creates a traffic distribution group given an Amazon Connect instance that has been replicated.   The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.  For more information about creating traffic distribution groups, see Set up traffic distribution groups in the Amazon Connect Administrator Guide.\n@required {Name: str, InstanceId: str}\n@optional {Description: str, ClientToken: str, Tags: map<str,str>}\n@returns(200) {Id: str?, Arn: str?}\n\n@endgroup\n\n@group instance\n@endpoint PUT /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases\n@desc Creates a use case for an integration association.\n@required {InstanceId: str, IntegrationAssociationId: str, UseCaseType: str}\n@optional {Tags: map<str,str>}\n@returns(200) {UseCaseId: str?, UseCaseArn: str?}\n\n@endgroup\n\n@group users\n@endpoint PUT /users/{InstanceId}\n@desc Creates a user account for the specified Amazon Connect instance.  Certain UserIdentityInfo parameters are required in some situations. For example, Email is required if you are using SAML for identity management. FirstName and LastName are required if you are using Amazon Connect or SAML for identity management.  For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.\n@required {InstanceId: str, Username: str, PhoneConfig: UserPhoneConfig, SecurityProfileIds: [str], RoutingProfileId: str}\n@optional {Password: str, IdentityInfo: UserIdentityInfo, DirectoryUserId: str, HierarchyGroupId: str, Tags: map<str,str>}\n@returns(200) {UserId: str?, UserArn: str?}\n\n@endgroup\n\n@group user-hierarchy-groups\n@endpoint PUT /user-hierarchy-groups/{InstanceId}\n@desc Creates a new user hierarchy group.\n@required {InstanceId: str, Name: str}\n@optional {ParentGroupId: str, Tags: map<str,str>}\n@returns(200) {HierarchyGroupId: str?, HierarchyGroupArn: str?}\n\n@endgroup\n\n@group views\n@endpoint PUT /views/{InstanceId}\n@desc Creates a new view with the possible status of SAVED or PUBLISHED. The views will have a unique name for each connect instance. It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.\n@required {InstanceId: str, Status: str, Content: ViewInputContent, Name: str}\n@optional {ClientToken: str, Description: str, Tags: map<str,str>}\n@returns(200) {View: View?{Id: str?, Arn: str?, Name: str?, Status: str?, Type: str?, Description: str?, Version: int?, VersionDescription: str?, Content: ViewContent?{InputSchema: str?, Template: str?, Actions: [str]?}, Tags: map<str, str>?: any, CreatedTime: str(timestamp)?, LastModifiedTime: str(timestamp)?, ViewContentSha256: str?}}\n\n@endpoint PUT /views/{InstanceId}/{ViewId}/versions\n@desc Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.\n@required {InstanceId: str, ViewId: str}\n@optional {VersionDescription: str, ViewContentSha256: str}\n@returns(200) {View: View?{Id: str?, Arn: str?, Name: str?, Status: str?, Type: str?, Description: str?, Version: int?, VersionDescription: str?, Content: ViewContent?{InputSchema: str?, Template: str?, Actions: [str]?}, Tags: map<str, str>?: any, CreatedTime: str(timestamp)?, LastModifiedTime: str(timestamp)?, ViewContentSha256: str?}}\n\n@endgroup\n\n@group vocabulary\n@endpoint POST /vocabulary/{InstanceId}\n@desc Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.\n@required {InstanceId: str, VocabularyName: str, LanguageCode: str, Content: str}\n@optional {ClientToken: str, Tags: map<str,str>}\n@returns(200) {VocabularyArn: str, VocabularyId: str, State: str}\n\n@endgroup\n\n@group evaluation-forms\n@endpoint POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/deactivate\n@desc Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.\n@required {InstanceId: str, EvaluationFormId: str, EvaluationFormVersion: int}\n@returns(200) {EvaluationFormId: str, EvaluationFormArn: str, EvaluationFormVersion: int}\n\n@endgroup\n\n@group attached-files\n@endpoint DELETE /attached-files/{InstanceId}/{FileId}\n@desc Deletes an attached file along with the underlying S3 Object.  The attached file is permanently deleted if S3 bucket versioning is not enabled.\n@required {InstanceId: str, FileId: str, associatedResourceArn: str}\n\n@endgroup\n\n@group contact-evaluations\n@endpoint DELETE /contact-evaluations/{InstanceId}/{EvaluationId}\n@desc Deletes a contact evaluation in the specified Amazon Connect instance.\n@required {InstanceId: str, EvaluationId: str}\n\n@endgroup\n\n@group contact-flows\n@endpoint DELETE /contact-flows/{InstanceId}/{ContactFlowId}\n@desc Deletes a flow for the specified Amazon Connect instance.\n@required {InstanceId: str, ContactFlowId: str}\n\n@endgroup\n\n@group contact-flow-modules\n@endpoint DELETE /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}\n@desc Deletes the specified flow module.\n@required {InstanceId: str, ContactFlowModuleId: str}\n\n@endgroup\n\n@group evaluation-forms\n@endpoint DELETE /evaluation-forms/{InstanceId}/{EvaluationFormId}\n@desc Deletes an evaluation form in the specified Amazon Connect instance.    If the version property is provided, only the specified version of the evaluation form is deleted.   If no version is provided, then the full form (all versions) is deleted.\n@required {InstanceId: str, EvaluationFormId: str}\n@optional {version: int}\n\n@endgroup\n\n@group hours-of-operations\n@endpoint DELETE /hours-of-operations/{InstanceId}/{HoursOfOperationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Deletes an hours of operation.\n@required {InstanceId: str, HoursOfOperationId: str}\n\n@endgroup\n\n@group instance\n@endpoint DELETE /instance/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.\n@required {InstanceId: str}\n\n@endpoint DELETE /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}\n@desc Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.\n@required {InstanceId: str, IntegrationAssociationId: str}\n\n@endgroup\n\n@group predefined-attributes\n@endpoint DELETE /predefined-attributes/{InstanceId}/{Name}\n@desc Deletes a predefined attribute from the specified Amazon Connect instance.\n@required {InstanceId: str, Name: str}\n\n@endgroup\n\n@group prompts\n@endpoint DELETE /prompts/{InstanceId}/{PromptId}\n@desc Deletes a prompt.\n@required {InstanceId: str, PromptId: str}\n\n@endgroup\n\n@group queues\n@endpoint DELETE /queues/{InstanceId}/{QueueId}\n@desc Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.\n@required {InstanceId: str, QueueId: str}\n\n@endgroup\n\n@group quick-connects\n@endpoint DELETE /quick-connects/{InstanceId}/{QuickConnectId}\n@desc Deletes a quick connect.   After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you:   Avoid dangling resources that impact your service quotas.   Remove deleted users so they don't appear to agents as transfer options.   Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.\n@required {InstanceId: str, QuickConnectId: str}\n\n@endgroup\n\n@group routing-profiles\n@endpoint DELETE /routing-profiles/{InstanceId}/{RoutingProfileId}\n@desc Deletes a routing profile.\n@required {InstanceId: str, RoutingProfileId: str}\n\n@endgroup\n\n@group rules\n@endpoint DELETE /rules/{InstanceId}/{RuleId}\n@desc Deletes a rule for the specified Amazon Connect instance.\n@required {InstanceId: str, RuleId: str}\n\n@endgroup\n\n@group security-profiles\n@endpoint DELETE /security-profiles/{InstanceId}/{SecurityProfileId}\n@desc Deletes a security profile.\n@required {InstanceId: str, SecurityProfileId: str}\n\n@endgroup\n\n@group instance\n@endpoint DELETE /instance/{InstanceId}/task/template/{TaskTemplateId}\n@desc Deletes the task template.\n@required {InstanceId: str, TaskTemplateId: str}\n\n@endgroup\n\n@group traffic-distribution-group\n@endpoint DELETE /traffic-distribution-group/{TrafficDistributionGroupId}\n@desc Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.\n@required {TrafficDistributionGroupId: str}\n\n@endgroup\n\n@group instance\n@endpoint DELETE /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}\n@desc Deletes a use case from an integration association.\n@required {InstanceId: str, IntegrationAssociationId: str, UseCaseId: str}\n\n@endgroup\n\n@group users\n@endpoint DELETE /users/{InstanceId}/{UserId}\n@desc Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.  After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:   Avoid dangling resources that impact your service quotas.   Remove deleted users so they don't appear to agents as transfer options.   Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.\n@required {InstanceId: str, UserId: str}\n\n@endgroup\n\n@group user-hierarchy-groups\n@endpoint DELETE /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}\n@desc Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.\n@required {HierarchyGroupId: str, InstanceId: str}\n\n@endgroup\n\n@group views\n@endpoint DELETE /views/{InstanceId}/{ViewId}\n@desc Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).\n@required {InstanceId: str, ViewId: str}\n\n@endpoint DELETE /views/{InstanceId}/{ViewId}/versions/{ViewVersion}\n@desc Deletes the particular version specified in ViewVersion identifier.\n@required {InstanceId: str, ViewId: str, ViewVersion: int}\n\n@endgroup\n\n@group vocabulary-remove\n@endpoint POST /vocabulary-remove/{InstanceId}/{VocabularyId}\n@desc Deletes the vocabulary that has the given identifier.\n@required {InstanceId: str, VocabularyId: str}\n@returns(200) {VocabularyArn: str, VocabularyId: str, State: str}\n\n@endgroup\n\n@group agent-status\n@endpoint GET /agent-status/{InstanceId}/{AgentStatusId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Describes an agent status.\n@required {InstanceId: str, AgentStatusId: str}\n@returns(200) {AgentStatus: AgentStatus?{AgentStatusARN: str?, AgentStatusId: str?, Name: str?, Description: str?, Type: str?, DisplayOrder: int?, State: str?, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group authentication-profiles\n@endpoint GET /authentication-profiles/{InstanceId}/{AuthenticationProfileId}\n@desc This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.\n@required {AuthenticationProfileId: str, InstanceId: str}\n@returns(200) {AuthenticationProfile: AuthenticationProfile?{Id: str?, Arn: str?, Name: str?, Description: str?, AllowedIps: [str]?, BlockedIps: [str]?, IsDefault: bool?, CreatedTime: str(timestamp)?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?, PeriodicSessionDuration: int?, MaxSessionDuration: int?}}\n\n@endgroup\n\n@group contacts\n@endpoint GET /contacts/{InstanceId}/{ContactId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact.   Contact information remains available in Amazon Connect for 24 months, and then it is deleted. Only data from November 12, 2021, and later is returned by this API.\n@required {InstanceId: str, ContactId: str}\n@returns(200) {Contact: Contact?{Arn: str?, Id: str?, InitialContactId: str?, PreviousContactId: str?, InitiationMethod: str?, Name: str?, Description: str?, Channel: str?, QueueInfo: QueueInfo?{Id: str?, EnqueueTimestamp: str(timestamp)?}, AgentInfo: AgentInfo?{Id: str?, ConnectedToAgentTimestamp: str(timestamp)?, AgentPauseDurationInSeconds: int?, HierarchyGroups: HierarchyGroups?{Level1: AgentHierarchyGroup?, Level2: AgentHierarchyGroup?, Level3: AgentHierarchyGroup?, Level4: AgentHierarchyGroup?, Level5: AgentHierarchyGroup?}, DeviceInfo: DeviceInfo?{PlatformName: str?, PlatformVersion: str?, OperatingSystem: str?}, Capabilities: ParticipantCapabilities?{Video: str?}}, InitiationTimestamp: str(timestamp)?, DisconnectTimestamp: str(timestamp)?, LastUpdateTimestamp: str(timestamp)?, LastPausedTimestamp: str(timestamp)?, LastResumedTimestamp: str(timestamp)?, TotalPauseCount: int?, TotalPauseDurationInSeconds: int?, ScheduledTimestamp: str(timestamp)?, RelatedContactId: str?, WisdomInfo: WisdomInfo?{SessionArn: str?}, QueueTimeAdjustmentSeconds: int?, QueuePriority: int(i64)?, Tags: map<str, str>?: any, ConnectedToSystemTimestamp: str(timestamp)?, RoutingCriteria: RoutingCriteria?{Steps: [Step]?, ActivationTimestamp: str(timestamp)?, Index: int?}, Customer: Customer?{DeviceInfo: DeviceInfo?{PlatformName: str?, PlatformVersion: str?, OperatingSystem: str?}, Capabilities: ParticipantCapabilities?{Video: str?}}, Campaign: Campaign?{CampaignId: str?}, AnsweringMachineDetectionStatus: str?, CustomerVoiceActivity: CustomerVoiceActivity?{GreetingStartTimestamp: str(timestamp)?, GreetingEndTimestamp: str(timestamp)?}, QualityMetrics: QualityMetrics?{Agent: AgentQualityMetrics?{Audio: AudioQualityMetricsInfo?}, Customer: CustomerQualityMetrics?{Audio: AudioQualityMetricsInfo?}}, DisconnectDetails: DisconnectDetails?{PotentialDisconnectIssue: str?}, SegmentAttributes: map<str, SegmentAttributeValue>?: any}}\n\n@endgroup\n\n@group contact-evaluations\n@endpoint GET /contact-evaluations/{InstanceId}/{EvaluationId}\n@desc Describes a contact evaluation in the specified Amazon Connect instance.\n@required {InstanceId: str, EvaluationId: str}\n@returns(200) {Evaluation: Evaluation{EvaluationId: str, EvaluationArn: str, Metadata: EvaluationMetadata{ContactId: str, EvaluatorArn: str, ContactAgentId: str?, Score: EvaluationScore?{Percentage: num(f64)?, NotApplicable: bool?, AutomaticFail: bool?}}, Answers: map<str, EvaluationAnswerOutput>: any, Notes: map<str, EvaluationNote>: any, Status: str, Scores: map<str, EvaluationScore>?: any, CreatedTime: str(timestamp), LastModifiedTime: str(timestamp), Tags: map<str, str>?: any}, EvaluationForm: EvaluationFormContent{EvaluationFormVersion: int, EvaluationFormId: str, EvaluationFormArn: str, Title: str, Description: str?, Items: [EvaluationFormItem], ScoringStrategy: EvaluationFormScoringStrategy?{Mode: str, Status: str}}}\n\n@endgroup\n\n@group contact-flows\n@endpoint GET /contact-flows/{InstanceId}/{ContactFlowId}\n@desc Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED\n@required {InstanceId: str, ContactFlowId: str}\n@returns(200) {ContactFlow: ContactFlow?{Arn: str?, Id: str?, Name: str?, Type: str?, State: str?, Status: str?, Description: str?, Content: str?, Tags: map<str, str>?: any}}\n\n@endgroup\n\n@group contact-flow-modules\n@endpoint GET /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}\n@desc Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.\n@required {InstanceId: str, ContactFlowModuleId: str}\n@returns(200) {ContactFlowModule: ContactFlowModule?{Arn: str?, Id: str?, Name: str?, Content: str?, Description: str?, State: str?, Status: str?, Tags: map<str, str>?: any}}\n\n@endgroup\n\n@group evaluation-forms\n@endpoint GET /evaluation-forms/{InstanceId}/{EvaluationFormId}\n@desc Describes 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.\n@required {InstanceId: str, EvaluationFormId: str}\n@optional {version: int}\n@returns(200) {EvaluationForm: EvaluationForm{EvaluationFormId: str, EvaluationFormVersion: int, Locked: bool, EvaluationFormArn: str, Title: str, Description: str?, Status: str, Items: [EvaluationFormItem], ScoringStrategy: EvaluationFormScoringStrategy?{Mode: str, Status: str}, CreatedTime: str(timestamp), CreatedBy: str, LastModifiedTime: str(timestamp), LastModifiedBy: str, Tags: map<str, str>?: any}}\n\n@endgroup\n\n@group hours-of-operations\n@endpoint GET /hours-of-operations/{InstanceId}/{HoursOfOperationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Describes the hours of operation.\n@required {InstanceId: str, HoursOfOperationId: str}\n@returns(200) {HoursOfOperation: HoursOfOperation?{HoursOfOperationId: str?, HoursOfOperationArn: str?, Name: str?, Description: str?, TimeZone: str?, Config: [HoursOfOperationConfig]?, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable.  If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.\n@required {InstanceId: str}\n@returns(200) {Instance: Instance?{Id: str?, Arn: str?, IdentityManagementType: str?, InstanceAlias: str?, CreatedTime: str(timestamp)?, ServiceRole: str?, InstanceStatus: str?, StatusReason: InstanceStatusReason?{Message: str?}, InboundCallsEnabled: bool?, OutboundCallsEnabled: bool?, InstanceAccessUrl: str?, Tags: map<str, str>?: any}, ReplicationConfiguration: ReplicationConfiguration?{ReplicationStatusSummaryList: [ReplicationStatusSummary]?, SourceRegion: str?, GlobalSignInEndpoint: str?}}\n\n@endpoint GET /instance/{InstanceId}/attribute/{AttributeType}\n@desc This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.\n@required {InstanceId: str, AttributeType: str}\n@returns(200) {Attribute: Attribute?{AttributeType: str?, Value: str?}}\n\n@endpoint GET /instance/{InstanceId}/storage-config/{AssociationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.\n@required {InstanceId: str, AssociationId: str, resourceType: str}\n@returns(200) {StorageConfig: InstanceStorageConfig?{AssociationId: str?, StorageType: str, S3Config: S3Config?{BucketName: str, BucketPrefix: str, EncryptionConfig: EncryptionConfig?{EncryptionType: str, KeyId: str}}, KinesisVideoStreamConfig: KinesisVideoStreamConfig?{Prefix: str, RetentionPeriodHours: int, EncryptionConfig: EncryptionConfig{EncryptionType: str, KeyId: str}}, KinesisStreamConfig: KinesisStreamConfig?{StreamArn: str}, KinesisFirehoseConfig: KinesisFirehoseConfig?{FirehoseArn: str}}}\n\n@endgroup\n\n@group phone-number\n@endpoint GET /phone-number/{PhoneNumberId}\n@desc Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.  If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.\n@required {PhoneNumberId: str}\n@returns(200) {ClaimedPhoneNumberSummary: ClaimedPhoneNumberSummary?{PhoneNumberId: str?, PhoneNumberArn: str?, PhoneNumber: str?, PhoneNumberCountryCode: str?, PhoneNumberType: str?, PhoneNumberDescription: str?, TargetArn: str?, InstanceId: str?, Tags: map<str, str>?: any, PhoneNumberStatus: PhoneNumberStatus?{Status: str?, Message: str?}, SourcePhoneNumberArn: str?}}\n\n@endgroup\n\n@group predefined-attributes\n@endpoint GET /predefined-attributes/{InstanceId}/{Name}\n@desc Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.\n@required {InstanceId: str, Name: str}\n@returns(200) {PredefinedAttribute: PredefinedAttribute?{Name: str?, Values: PredefinedAttributeValues?{StringList: [str]?}, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group prompts\n@endpoint GET /prompts/{InstanceId}/{PromptId}\n@desc Describes the prompt.\n@required {InstanceId: str, PromptId: str}\n@returns(200) {Prompt: Prompt?{PromptARN: str?, PromptId: str?, Name: str?, Description: str?, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group queues\n@endpoint GET /queues/{InstanceId}/{QueueId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue.\n@required {InstanceId: str, QueueId: str}\n@returns(200) {Queue: Queue?{Name: str?, QueueArn: str?, QueueId: str?, Description: str?, OutboundCallerConfig: OutboundCallerConfig?{OutboundCallerIdName: str?, OutboundCallerIdNumberId: str?, OutboundFlowId: str?}, HoursOfOperationId: str?, MaxContacts: int?, Status: str?, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group quick-connects\n@endpoint GET /quick-connects/{InstanceId}/{QuickConnectId}\n@desc Describes the quick connect.\n@required {InstanceId: str, QuickConnectId: str}\n@returns(200) {QuickConnect: QuickConnect?{QuickConnectARN: str?, QuickConnectId: str?, Name: str?, Description: str?, QuickConnectConfig: QuickConnectConfig?{QuickConnectType: str, UserConfig: UserQuickConnectConfig?{UserId: str, ContactFlowId: str}, QueueConfig: QueueQuickConnectConfig?{QueueId: str, ContactFlowId: str}, PhoneConfig: PhoneNumberQuickConnectConfig?{PhoneNumber: str}}, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group routing-profiles\n@endpoint GET /routing-profiles/{InstanceId}/{RoutingProfileId}\n@desc Describes the specified routing profile.\n@required {InstanceId: str, RoutingProfileId: str}\n@returns(200) {RoutingProfile: RoutingProfile?{InstanceId: str?, Name: str?, RoutingProfileArn: str?, RoutingProfileId: str?, Description: str?, MediaConcurrencies: [MediaConcurrency]?, DefaultOutboundQueueId: str?, Tags: map<str, str>?: any, NumberOfAssociatedQueues: int(i64)?, NumberOfAssociatedUsers: int(i64)?, AgentAvailabilityTimer: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?, IsDefault: bool?, AssociatedQueueIds: [str]?}}\n\n@endgroup\n\n@group rules\n@endpoint GET /rules/{InstanceId}/{RuleId}\n@desc Describes a rule for the specified Amazon Connect instance.\n@required {InstanceId: str, RuleId: str}\n@returns(200) {Rule: Rule{Name: str, RuleId: str, RuleArn: str, TriggerEventSource: RuleTriggerEventSource{EventSourceName: str, IntegrationAssociationId: str?}, Function: str, Actions: [RuleAction], PublishStatus: str, CreatedTime: str(timestamp), LastUpdatedTime: str(timestamp), LastUpdatedBy: str, Tags: map<str, str>?: any}}\n\n@endgroup\n\n@group security-profiles\n@endpoint GET /security-profiles/{InstanceId}/{SecurityProfileId}\n@desc Gets basic information about the 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.\n@required {SecurityProfileId: str, InstanceId: str}\n@returns(200) {SecurityProfile: SecurityProfile?{Id: str?, OrganizationResourceId: str?, Arn: str?, SecurityProfileName: str?, Description: str?, Tags: map<str, str>?: any, AllowedAccessControlTags: map<str, str>?: any, TagRestrictedResources: [str]?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?, HierarchyRestrictedResources: [str]?, AllowedAccessControlHierarchyGroupId: str?}}\n\n@endgroup\n\n@group traffic-distribution-group\n@endpoint GET /traffic-distribution-group/{TrafficDistributionGroupId}\n@desc Gets details and status of a traffic distribution group.\n@required {TrafficDistributionGroupId: str}\n@returns(200) {TrafficDistributionGroup: TrafficDistributionGroup?{Id: str?, Arn: str?, Name: str?, Description: str?, InstanceArn: str?, Status: str?, Tags: map<str, str>?: any, IsDefault: bool?}}\n\n@endgroup\n\n@group users\n@endpoint GET /users/{InstanceId}/{UserId}\n@desc Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.\n@required {UserId: str, InstanceId: str}\n@returns(200) {User: User?{Id: str?, Arn: str?, Username: str?, IdentityInfo: UserIdentityInfo?{FirstName: str?, LastName: str?, Email: str?, SecondaryEmail: str?, Mobile: str?}, PhoneConfig: UserPhoneConfig?{PhoneType: str, AutoAccept: bool?, AfterContactWorkTimeLimit: int?, DeskPhoneNumber: str?}, DirectoryUserId: str?, SecurityProfileIds: [str]?, RoutingProfileId: str?, HierarchyGroupId: str?, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group user-hierarchy-groups\n@endpoint GET /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}\n@desc Describes the specified hierarchy group.\n@required {HierarchyGroupId: str, InstanceId: str}\n@returns(200) {HierarchyGroup: HierarchyGroup?{Id: str?, Arn: str?, Name: str?, LevelId: str?, HierarchyPath: HierarchyPath?{LevelOne: HierarchyGroupSummary?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelTwo: HierarchyGroupSummary?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelThree: HierarchyGroupSummary?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelFour: HierarchyGroupSummary?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelFive: HierarchyGroupSummary?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}, Tags: map<str, str>?: any, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}\n\n@endgroup\n\n@group user-hierarchy-structure\n@endpoint GET /user-hierarchy-structure/{InstanceId}\n@desc Describes the hierarchy structure of the specified Amazon Connect instance.\n@required {InstanceId: str}\n@returns(200) {HierarchyStructure: HierarchyStructure?{LevelOne: HierarchyLevel?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelTwo: HierarchyLevel?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelThree: HierarchyLevel?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelFour: HierarchyLevel?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}, LevelFive: HierarchyLevel?{Id: str?, Arn: str?, Name: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}}}\n\n@endgroup\n\n@group views\n@endpoint GET /views/{InstanceId}/{ViewId}\n@desc Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN.  $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, :$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.\n@required {InstanceId: str, ViewId: str}\n@returns(200) {View: View?{Id: str?, Arn: str?, Name: str?, Status: str?, Type: str?, Description: str?, Version: int?, VersionDescription: str?, Content: ViewContent?{InputSchema: str?, Template: str?, Actions: [str]?}, Tags: map<str, str>?: any, CreatedTime: str(timestamp)?, LastModifiedTime: str(timestamp)?, ViewContentSha256: str?}}\n\n@endgroup\n\n@group vocabulary\n@endpoint GET /vocabulary/{InstanceId}/{VocabularyId}\n@desc Describes the specified vocabulary.\n@required {InstanceId: str, VocabularyId: str}\n@returns(200) {Vocabulary: Vocabulary{Name: str, Id: str, Arn: str, LanguageCode: str, State: str, LastModifiedTime: str(timestamp), FailureReason: str?, Content: str?, Tags: map<str, str>?: any}}\n\n@endgroup\n\n@group analytics-data\n@endpoint POST /analytics-data/instance/{InstanceId}/association\n@desc This API is in preview release for Amazon Connect and is subject to change. Removes the dataset ID associated with a given Amazon Connect instance.\n@required {InstanceId: str, DataSetId: str}\n@optional {TargetAccountId: str}\n\n@endgroup\n\n@group instance\n@endpoint DELETE /instance/{InstanceId}/approved-origin\n@desc This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect.\n@required {InstanceId: str, origin: str}\n\n@endpoint POST /instance/{InstanceId}/bot\n@desc This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.\n@required {InstanceId: str}\n@optional {LexBot: LexBot, LexV2Bot: LexV2Bot}\n\n@endgroup\n\n@group flow-associations\n@endpoint DELETE /flow-associations/{InstanceId}/{ResourceId}/{ResourceType}\n@desc Disassociates a connect resource from a flow.\n@required {InstanceId: str, ResourceId: str, ResourceType: str}\n\n@endgroup\n\n@group instance\n@endpoint DELETE /instance/{InstanceId}/storage-config/{AssociationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID.\n@required {InstanceId: str, AssociationId: str, resourceType: str}\n\n@endpoint DELETE /instance/{InstanceId}/lambda-function\n@desc This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks.\n@required {InstanceId: str, functionArn: str}\n\n@endpoint DELETE /instance/{InstanceId}/lex-bot\n@desc This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot.\n@required {InstanceId: str, botName: str, lexRegion: str}\n\n@endgroup\n\n@group phone-number\n@endpoint DELETE /phone-number/{PhoneNumberId}/contact-flow\n@desc Removes the flow association from a phone number claimed to your Amazon Connect instance.  If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.\n@required {PhoneNumberId: str, instanceId: str}\n\n@endgroup\n\n@group queues\n@endpoint POST /queues/{InstanceId}/{QueueId}/disassociate-quick-connects\n@desc This API is in preview release for Amazon Connect and is subject to change. Disassociates a set of quick connects from a queue.\n@required {InstanceId: str, QueueId: str, QuickConnectIds: [str]}\n\n@endgroup\n\n@group routing-profiles\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues\n@desc Disassociates a set of queues from a routing profile.\n@required {InstanceId: str, RoutingProfileId: str, QueueReferences: [RoutingProfileQueueReference]}\n\n@endgroup\n\n@group instance\n@endpoint DELETE /instance/{InstanceId}/security-key/{AssociationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key.\n@required {InstanceId: str, AssociationId: str}\n\n@endgroup\n\n@group traffic-distribution-group\n@endpoint DELETE /traffic-distribution-group/{TrafficDistributionGroupId}/user\n@desc Disassociates an agent from a traffic distribution group.\n@required {TrafficDistributionGroupId: str, UserId: str, InstanceId: str}\n\n@endgroup\n\n@group users\n@endpoint POST /users/{InstanceId}/{UserId}/disassociate-proficiencies\n@desc Disassociates a set of proficiencies from a user.\n@required {InstanceId: str, UserId: str, UserProficiencies: [UserProficiencyDisassociate]}\n\n@endpoint POST /users/{InstanceId}/{UserId}/contact\n@desc Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.\n@required {UserId: str, InstanceId: str, ContactId: str}\n\n@endgroup\n\n@group attached-files\n@endpoint GET /attached-files/{InstanceId}/{FileId}\n@desc Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.\n@required {InstanceId: str, FileId: str, associatedResourceArn: str}\n@optional {urlExpiryInSeconds: int}\n@returns(200) {FileArn: str?, FileId: str?, CreationTime: str?, FileStatus: str?, FileName: str?, FileSizeInBytes: int(i64), AssociatedResourceArn: str?, FileUseCaseType: str?, CreatedBy: CreatedByInfo?{ConnectUserArn: str?, AWSIdentityArn: str?}, DownloadUrlMetadata: DownloadUrlMetadata?{Url: str?, UrlExpiry: str?}, Tags: map<str,str>?}\n\n@endgroup\n\n@group contact\n@endpoint GET /contact/attributes/{InstanceId}/{InitialContactId}\n@desc Retrieves the contact attributes for the specified contact.\n@required {InstanceId: str, InitialContactId: str}\n@returns(200) {Attributes: map<str,str>?}\n\n@endgroup\n\n@group metrics\n@endpoint POST /metrics/current/{InstanceId}\n@desc Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.\n@required {InstanceId: str, Filters: Filters, CurrentMetrics: [CurrentMetric]}\n@optional {Groupings: [str], NextToken: str, MaxResults: int, SortCriteria: [CurrentMetricSortCriteria]}\n@returns(200) {NextToken: str?, MetricResults: [CurrentMetricResult]?, DataSnapshotTime: str(timestamp)?, ApproximateTotalCount: int(i64)?}\n\n@endpoint POST /metrics/userdata/{InstanceId}\n@desc Gets the real-time active user data from the specified Amazon Connect instance.\n@required {InstanceId: str, Filters: UserDataFilters}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, UserDataList: [UserData]?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group user\n@endpoint GET /user/federate/{InstanceId}\n@desc Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action.  For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide.   This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:   Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect\n@required {InstanceId: str}\n@returns(200) {Credentials: Credentials?{AccessToken: str?, AccessTokenExpiration: str(timestamp)?, RefreshToken: str?, RefreshTokenExpiration: str(timestamp)?}, SignInUrl: str?, UserArn: str?, UserId: str?}\n\n@endgroup\n\n@group flow-associations\n@endpoint GET /flow-associations/{InstanceId}/{ResourceId}/{ResourceType}\n@desc Retrieves the flow associated for a given resource.\n@required {InstanceId: str, ResourceId: str, ResourceType: str}\n@returns(200) {ResourceId: str?, FlowId: str?, ResourceType: str?}\n\n@endgroup\n\n@group metrics\n@endpoint POST /metrics/historical/{InstanceId}\n@desc Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.  We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.\n@required {InstanceId: str, StartTime: str(timestamp), EndTime: str(timestamp), Filters: Filters, HistoricalMetrics: [HistoricalMetric]}\n@optional {Groupings: [str], NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, MetricResults: [HistoricalMetricResult]?}\n\n@endpoint POST /metrics/data\n@desc Gets metric data from the specified Amazon Connect instance.   GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.  For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator Guide.\n@required {ResourceArn: str, StartTime: str(timestamp), EndTime: str(timestamp), Filters: [FilterV2], Metrics: [MetricV2]}\n@optional {Interval: IntervalDetails, Groupings: [str], NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, MetricResults: [MetricResultV2]?}\n\n@endgroup\n\n@group prompts\n@endpoint GET /prompts/{InstanceId}/{PromptId}/file\n@desc Gets the prompt file.\n@required {InstanceId: str, PromptId: str}\n@returns(200) {PromptPresignedUrl: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/task/template/{TaskTemplateId}\n@desc Gets details about a specific task template in the specified Amazon Connect instance.\n@required {InstanceId: str, TaskTemplateId: str}\n@optional {snapshotVersion: str}\n@returns(200) {InstanceId: str?, Id: str, Arn: str, Name: str, Description: str?, ContactFlowId: str?, Constraints: TaskTemplateConstraints?{RequiredFields: [RequiredFieldInfo]?, ReadOnlyFields: [ReadOnlyFieldInfo]?, InvisibleFields: [InvisibleFieldInfo]?}, Defaults: TaskTemplateDefaults?{DefaultFieldValues: [TaskTemplateDefaultFieldValue]?}, Fields: [TaskTemplateField]?, Status: str?, LastModifiedTime: str(timestamp)?, CreatedTime: str(timestamp)?, Tags: map<str,str>?}\n\n@endgroup\n\n@group traffic-distribution\n@endpoint GET /traffic-distribution/{Id}\n@desc Retrieves the current traffic distribution for a given traffic distribution group.\n@required {Id: str}\n@returns(200) {TelephonyConfig: TelephonyConfig?{Distributions: [Distribution]}, Id: str?, Arn: str?, SignInConfig: SignInConfig?{Distributions: [SignInDistribution]}, AgentConfig: AgentConfig?{Distributions: [Distribution]}}\n\n@endgroup\n\n@group phone-number\n@endpoint POST /phone-number/import\n@desc Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.  Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.   If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.   By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.  For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.\n@required {InstanceId: str, SourcePhoneNumberArn: str}\n@optional {PhoneNumberDescription: str, Tags: map<str,str>, ClientToken: str}\n@returns(200) {PhoneNumberId: str?, PhoneNumberArn: str?}\n\n@endgroup\n\n@group agent-status\n@endpoint GET /agent-status/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Lists agent statuses.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int, AgentStatusTypes: [str]}\n@returns(200) {NextToken: str?, AgentStatusSummaryList: [AgentStatusSummary]?}\n\n@endgroup\n\n@group analytics-data\n@endpoint GET /analytics-data/instance/{InstanceId}/association\n@desc This API is in preview release for Amazon Connect and is subject to change. Lists the association status of requested dataset ID for a given Amazon Connect instance.\n@required {InstanceId: str}\n@optional {DataSetId: str, nextToken: str, maxResults: int}\n@returns(200) {Results: [AnalyticsDataAssociationResult]?, NextToken: str?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/approved-origins\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {Origins: [str]?, NextToken: str?}\n\n@endgroup\n\n@group authentication-profiles-summary\n@endpoint GET /authentication-profiles-summary/{InstanceId}\n@desc This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {AuthenticationProfileSummaryList: [AuthenticationProfileSummary]?, NextToken: str?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/bots\n@desc This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots.\n@required {InstanceId: str, lexVersion: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {LexBots: [LexBotConfig]?, NextToken: str?}\n\n@endgroup\n\n@group contact-evaluations\n@endpoint GET /contact-evaluations/{InstanceId}\n@desc Lists contact evaluations in the specified Amazon Connect instance.\n@required {InstanceId: str, contactId: str}\n@optional {nextToken: str}\n@returns(200) {EvaluationSummaryList: [EvaluationSummary], NextToken: str?}\n\n@endgroup\n\n@group contact-flow-modules-summary\n@endpoint GET /contact-flow-modules-summary/{InstanceId}\n@desc Provides information about the flow modules for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int, state: str}\n@returns(200) {ContactFlowModulesSummaryList: [ContactFlowModuleSummary]?, NextToken: str?}\n\n@endgroup\n\n@group contact-flows-summary\n@endpoint GET /contact-flows-summary/{InstanceId}\n@desc Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide.\n@required {InstanceId: str}\n@optional {contactFlowTypes: [str], nextToken: str, maxResults: int}\n@returns(200) {ContactFlowSummaryList: [ContactFlowSummary]?, NextToken: str?}\n\n@endgroup\n\n@group contact\n@endpoint GET /contact/references/{InstanceId}/{ContactId}\n@desc This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.\n@required {InstanceId: str, ContactId: str, referenceTypes: [str]}\n@optional {nextToken: str}\n@returns(200) {ReferenceSummaryList: [ReferenceSummary]?, NextToken: str?}\n\n@endgroup\n\n@group default-vocabulary-summary\n@endpoint POST /default-vocabulary-summary/{InstanceId}\n@desc Lists the default vocabularies for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {LanguageCode: str, MaxResults: int, NextToken: str}\n@returns(200) {DefaultVocabularyList: [DefaultVocabulary], NextToken: str?}\n\n@endgroup\n\n@group evaluation-forms\n@endpoint GET /evaluation-forms/{InstanceId}/{EvaluationFormId}/versions\n@desc Lists versions of an evaluation form in the specified Amazon Connect instance.\n@required {InstanceId: str, EvaluationFormId: str}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {EvaluationFormVersionSummaryList: [EvaluationFormVersionSummary], NextToken: str?}\n\n@endpoint GET /evaluation-forms/{InstanceId}\n@desc Lists evaluation forms in the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {EvaluationFormSummaryList: [EvaluationFormSummary], NextToken: str?}\n\n@endgroup\n\n@group flow-associations-summary\n@endpoint GET /flow-associations-summary/{InstanceId}\n@desc List the flow association based on the filters.\n@required {InstanceId: str}\n@optional {ResourceType: str, nextToken: str, maxResults: int}\n@returns(200) {FlowAssociationSummaryList: [FlowAssociationSummary]?, NextToken: str?}\n\n@endgroup\n\n@group hours-of-operations-summary\n@endpoint GET /hours-of-operations-summary/{InstanceId}\n@desc Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {HoursOfOperationSummaryList: [HoursOfOperationSummary]?, NextToken: str?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/attributes\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {Attributes: [Attribute]?, NextToken: str?}\n\n@endpoint GET /instance/{InstanceId}/storage-configs\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.\n@required {InstanceId: str, resourceType: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {StorageConfigs: [InstanceStorageConfig]?, NextToken: str?}\n\n@endpoint GET /instance\n@desc This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.\n@optional {nextToken: str, maxResults: int}\n@returns(200) {InstanceSummaryList: [InstanceSummary]?, NextToken: str?}\n\n@endpoint GET /instance/{InstanceId}/integration-associations\n@desc Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {integrationType: str, nextToken: str, maxResults: int, integrationArn: str}\n@returns(200) {IntegrationAssociationSummaryList: [IntegrationAssociationSummary]?, NextToken: str?}\n\n@endpoint GET /instance/{InstanceId}/lambda-functions\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {LambdaFunctions: [str]?, NextToken: str?}\n\n@endpoint GET /instance/{InstanceId}/lex-bots\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the ListBots API.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {LexBots: [LexBot]?, NextToken: str?}\n\n@endgroup\n\n@group phone-numbers-summary\n@endpoint GET /phone-numbers-summary/{InstanceId}\n@desc Provides information about the phone numbers for the specified Amazon Connect instance.  For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.    We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID.    The phone number Arn value that is returned from each of the items in the PhoneNumberSummaryList cannot be used to tag phone number resources. It will fail with a ResourceNotFoundException. Instead, use the ListPhoneNumbersV2 API. It returns the new phone number ARN that can be used to tag phone number resources.\n@required {InstanceId: str}\n@optional {phoneNumberTypes: [str], phoneNumberCountryCodes: [str], nextToken: str, maxResults: int}\n@returns(200) {PhoneNumberSummaryList: [PhoneNumberSummary]?, NextToken: str?}\n\n@endgroup\n\n@group phone-number\n@endpoint POST /phone-number/list\n@desc Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.    When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance.   When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers claimed to the traffic distribution group.\n@optional {TargetArn: str, InstanceId: str, MaxResults: int, NextToken: str, PhoneNumberCountryCodes: [str], PhoneNumberTypes: [str], PhoneNumberPrefix: str}\n@returns(200) {NextToken: str?, ListPhoneNumbersSummaryList: [ListPhoneNumbersSummary]?}\n\n@endgroup\n\n@group predefined-attributes\n@endpoint GET /predefined-attributes/{InstanceId}\n@desc Lists predefined attributes for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {NextToken: str?, PredefinedAttributeSummaryList: [PredefinedAttributeSummary]?}\n\n@endgroup\n\n@group prompts-summary\n@endpoint GET /prompts-summary/{InstanceId}\n@desc Provides information about the prompts for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {PromptSummaryList: [PromptSummary]?, NextToken: str?}\n\n@endgroup\n\n@group queues\n@endpoint GET /queues/{InstanceId}/{QueueId}/quick-connects\n@desc This API is in preview release for Amazon Connect and is subject to change. Lists the quick connects associated with a queue.\n@required {InstanceId: str, QueueId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {NextToken: str?, QuickConnectSummaryList: [QuickConnectSummary]?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}\n\n@endgroup\n\n@group queues-summary\n@endpoint GET /queues-summary/{InstanceId}\n@desc Provides information about the queues for the specified Amazon Connect instance. If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.\n@required {InstanceId: str}\n@optional {queueTypes: [str], nextToken: str, maxResults: int}\n@returns(200) {QueueSummaryList: [QueueSummary]?, NextToken: str?}\n\n@endgroup\n\n@group quick-connects\n@endpoint GET /quick-connects/{InstanceId}\n@desc Provides information about the quick connects for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int, QuickConnectTypes: [str]}\n@returns(200) {QuickConnectSummaryList: [QuickConnectSummary]?, NextToken: str?}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}\n@desc Provides a list of analysis segments for a real-time analysis session.\n@required {InstanceId: str, ContactId: str, OutputType: str, SegmentTypes: [str]}\n@optional {MaxResults: int, NextToken: str}\n@returns(200) {Channel: str, Status: str, Segments: [RealtimeContactAnalysisSegment], NextToken: str?}\n\n@endgroup\n\n@group routing-profiles\n@endpoint GET /routing-profiles/{InstanceId}/{RoutingProfileId}/queues\n@desc Lists the queues associated with a routing profile.\n@required {InstanceId: str, RoutingProfileId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {NextToken: str?, RoutingProfileQueueConfigSummaryList: [RoutingProfileQueueConfigSummary]?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}\n\n@endgroup\n\n@group routing-profiles-summary\n@endpoint GET /routing-profiles-summary/{InstanceId}\n@desc Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {RoutingProfileSummaryList: [RoutingProfileSummary]?, NextToken: str?}\n\n@endgroup\n\n@group rules\n@endpoint GET /rules/{InstanceId}\n@desc List all rules for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {publishStatus: str, eventSourceName: str, maxResults: int, nextToken: str}\n@returns(200) {RuleSummaryList: [RuleSummary], NextToken: str?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/security-keys\n@desc This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all security keys associated with the instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {SecurityKeys: [SecurityKey]?, NextToken: str?}\n\n@endgroup\n\n@group security-profiles-applications\n@endpoint GET /security-profiles-applications/{InstanceId}/{SecurityProfileId}\n@desc Returns a list of third-party applications in a specific security profile.\n@required {SecurityProfileId: str, InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {Applications: [Application]?, NextToken: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}\n\n@endgroup\n\n@group security-profiles-permissions\n@endpoint GET /security-profiles-permissions/{InstanceId}/{SecurityProfileId}\n@desc Lists the permissions granted to 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.\n@required {SecurityProfileId: str, InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {Permissions: [str]?, NextToken: str?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}\n\n@endgroup\n\n@group security-profiles-summary\n@endpoint GET /security-profiles-summary/{InstanceId}\n@desc Provides summary information about the security profiles for the specified Amazon Connect instance. For more 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.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {SecurityProfileSummaryList: [SecurityProfileSummary]?, NextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resourceArn}\n@desc Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.\n@required {resourceArn: str}\n@returns(200) {tags: map<str,str>?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/task/template\n@desc Lists task templates for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int, status: str, name: str}\n@returns(200) {TaskTemplates: [TaskTemplateMetadata]?, NextToken: str?}\n\n@endgroup\n\n@group traffic-distribution-group\n@endpoint GET /traffic-distribution-group/{TrafficDistributionGroupId}/user\n@desc Lists traffic distribution group users.\n@required {TrafficDistributionGroupId: str}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {NextToken: str?, TrafficDistributionGroupUserSummaryList: [TrafficDistributionGroupUserSummary]?}\n\n@endgroup\n\n@group traffic-distribution-groups\n@endpoint GET /traffic-distribution-groups\n@desc Lists traffic distribution groups.\n@optional {maxResults: int, nextToken: str, instanceId: str}\n@returns(200) {NextToken: str?, TrafficDistributionGroupSummaryList: [TrafficDistributionGroupSummary]?}\n\n@endgroup\n\n@group instance\n@endpoint GET /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases\n@desc Lists the use cases for the integration association.\n@required {InstanceId: str, IntegrationAssociationId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {UseCaseSummaryList: [UseCase]?, NextToken: str?}\n\n@endgroup\n\n@group user-hierarchy-groups-summary\n@endpoint GET /user-hierarchy-groups-summary/{InstanceId}\n@desc Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {UserHierarchyGroupSummaryList: [HierarchyGroupSummary]?, NextToken: str?}\n\n@endgroup\n\n@group users\n@endpoint GET /users/{InstanceId}/{UserId}/proficiencies\n@desc Lists proficiencies associated with a user.\n@required {InstanceId: str, UserId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {NextToken: str?, UserProficiencyList: [UserProficiency]?, LastModifiedTime: str(timestamp)?, LastModifiedRegion: str?}\n\n@endgroup\n\n@group users-summary\n@endpoint GET /users-summary/{InstanceId}\n@desc Provides summary information about the users for the specified Amazon Connect instance.\n@required {InstanceId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {UserSummaryList: [UserSummary]?, NextToken: str?}\n\n@endgroup\n\n@group views\n@endpoint GET /views/{InstanceId}/{ViewId}/versions\n@desc Returns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest.\n@required {InstanceId: str, ViewId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {ViewVersionSummaryList: [ViewVersionSummary]?, NextToken: str?}\n\n@endpoint GET /views/{InstanceId}\n@desc Returns views in the given instance. Results are sorted primarily by type, and secondarily by name.\n@required {InstanceId: str}\n@optional {type: str, nextToken: str, maxResults: int}\n@returns(200) {ViewsSummaryList: [ViewSummary]?, NextToken: str?}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/monitor\n@desc Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by userId will be set to silent monitoring mode on the contact.\n@required {InstanceId: str, ContactId: str, UserId: str}\n@optional {AllowedMonitorCapabilities: [str], ClientToken: str}\n@returns(200) {ContactId: str?, ContactArn: str?}\n\n@endpoint POST /contact/pause\n@desc Allows pausing an ongoing task contact.\n@required {ContactId: str, InstanceId: str}\n@optional {ContactFlowId: str}\n\n@endgroup\n\n@group users\n@endpoint PUT /users/{InstanceId}/{UserId}/status\n@desc Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.\n@required {UserId: str, InstanceId: str, AgentStatusId: str}\n\n@endgroup\n\n@group phone-number\n@endpoint DELETE /phone-number/{PhoneNumberId}\n@desc Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.  To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.  If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired.  For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.\n@required {PhoneNumberId: str}\n@optional {clientToken: str}\n\n@endgroup\n\n@group instance\n@endpoint POST /instance/{InstanceId}/replicate\n@desc Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.  For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.\n@required {InstanceId: str, ReplicaRegion: str, ReplicaAlias: str}\n@optional {ClientToken: str}\n@returns(200) {Id: str?, Arn: str?}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/resume\n@desc Allows resuming a task contact in a paused state.\n@required {ContactId: str, InstanceId: str}\n@optional {ContactFlowId: str}\n\n@endpoint POST /contact/resume-recording\n@desc When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported.\n@required {InstanceId: str, ContactId: str, InitialContactId: str}\n\n@endgroup\n\n@group search-agent-statuses\n@endpoint POST /search-agent-statuses\n@desc Searches AgentStatuses in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: AgentStatusSearchFilter, SearchCriteria: AgentStatusSearchCriteria}\n@returns(200) {AgentStatuses: [AgentStatus]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group phone-number\n@endpoint POST /phone-number/search-available\n@desc Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.\n@required {PhoneNumberCountryCode: str, PhoneNumberType: str}\n@optional {TargetArn: str, InstanceId: str, PhoneNumberPrefix: str, MaxResults: int, NextToken: str}\n@returns(200) {NextToken: str?, AvailableNumbersList: [AvailableNumberSummary]?}\n\n@endgroup\n\n@group search-contact-flow-modules\n@endpoint POST /search-contact-flow-modules\n@desc Searches the flow modules in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: ContactFlowModuleSearchFilter, SearchCriteria: ContactFlowModuleSearchCriteria}\n@returns(200) {ContactFlowModules: [ContactFlowModule]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-contact-flows\n@endpoint POST /search-contact-flows\n@desc Searches the contact flows in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: ContactFlowSearchFilter, SearchCriteria: ContactFlowSearchCriteria}\n@returns(200) {ContactFlows: [ContactFlow]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-contacts\n@endpoint POST /search-contacts\n@desc Searches contacts in an Amazon Connect instance.\n@required {InstanceId: str, TimeRange: SearchContactsTimeRange}\n@optional {SearchCriteria: SearchCriteria, MaxResults: int, NextToken: str, Sort: Sort}\n@returns(200) {Contacts: [ContactSearchSummary], NextToken: str?, TotalCount: int(i64)?}\n\n@endgroup\n\n@group search-hours-of-operations\n@endpoint POST /search-hours-of-operations\n@desc Searches the hours of operation in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: HoursOfOperationSearchFilter, SearchCriteria: HoursOfOperationSearchCriteria}\n@returns(200) {HoursOfOperations: [HoursOfOperation]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-predefined-attributes\n@endpoint POST /search-predefined-attributes\n@desc Searches predefined attributes that meet certain criteria. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchCriteria: PredefinedAttributeSearchCriteria}\n@returns(200) {PredefinedAttributes: [PredefinedAttribute]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-prompts\n@endpoint POST /search-prompts\n@desc Searches prompts in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: PromptSearchFilter, SearchCriteria: PromptSearchCriteria}\n@returns(200) {Prompts: [Prompt]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-queues\n@endpoint POST /search-queues\n@desc Searches queues in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: QueueSearchFilter, SearchCriteria: QueueSearchCriteria}\n@returns(200) {Queues: [Queue]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-quick-connects\n@endpoint POST /search-quick-connects\n@desc Searches quick connects in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: QuickConnectSearchFilter, SearchCriteria: QuickConnectSearchCriteria}\n@returns(200) {QuickConnects: [QuickConnect]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-resource-tags\n@endpoint POST /search-resource-tags\n@desc Searches tags used in an Amazon Connect instance using optional search criteria.\n@required {InstanceId: str}\n@optional {ResourceTypes: [str], NextToken: str, MaxResults: int, SearchCriteria: ResourceTagsSearchCriteria}\n@returns(200) {Tags: [TagSet]?, NextToken: str?}\n\n@endgroup\n\n@group search-routing-profiles\n@endpoint POST /search-routing-profiles\n@desc Searches routing profiles in an Amazon Connect instance, with optional filtering.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: RoutingProfileSearchFilter, SearchCriteria: RoutingProfileSearchCriteria}\n@returns(200) {RoutingProfiles: [RoutingProfile]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-security-profiles\n@endpoint POST /search-security-profiles\n@desc Searches security profiles in an Amazon Connect instance, with optional filtering. 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.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchCriteria: SecurityProfileSearchCriteria, SearchFilter: SecurityProfilesSearchFilter}\n@returns(200) {SecurityProfiles: [SecurityProfileSearchSummary]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-user-hierarchy-groups\n@endpoint POST /search-user-hierarchy-groups\n@desc Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.  The UserHierarchyGroup with \"LevelId\": \"0\" is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: UserHierarchyGroupSearchFilter, SearchCriteria: UserHierarchyGroupSearchCriteria}\n@returns(200) {UserHierarchyGroups: [HierarchyGroup]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group search-users\n@endpoint POST /search-users\n@desc Searches users in an Amazon Connect instance, with optional filtering.    AfterContactWorkTimeLimit is returned in milliseconds.\n@required {InstanceId: str}\n@optional {NextToken: str, MaxResults: int, SearchFilter: UserSearchFilter, SearchCriteria: UserSearchCriteria}\n@returns(200) {Users: [UserSearchSummary]?, NextToken: str?, ApproximateTotalCount: int(i64)?}\n\n@endgroup\n\n@group vocabulary-summary\n@endpoint POST /vocabulary-summary/{InstanceId}\n@desc Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.\n@required {InstanceId: str}\n@optional {MaxResults: int, NextToken: str, State: str, NameStartsWith: str, LanguageCode: str}\n@returns(200) {VocabularySummaryList: [VocabularySummary]?, NextToken: str?}\n\n@endgroup\n\n@group chat-integration-event\n@endpoint POST /chat-integration-event\n@desc Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes:   SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat    ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat   When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action.  Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.\n@required {SourceId: str, DestinationId: str, Event: ChatEvent}\n@optional {Subtype: str, NewSessionDetails: NewSessionDetails}\n@returns(200) {InitialContactId: str?, NewChatCreated: bool?}\n\n@endgroup\n\n@group attached-files\n@endpoint PUT /attached-files/{InstanceId}\n@desc Provides a pre-signed Amazon S3 URL in response for uploading your content.  You may only use this API to upload attachments to an Amazon Connect Case.\n@required {InstanceId: str, associatedResourceArn: str, FileName: str, FileSizeInBytes: int(i64), FileUseCaseType: str}\n@optional {ClientToken: str, UrlExpiryInSeconds: int, CreatedBy: CreatedByInfo, Tags: map<str,str>}\n@returns(200) {FileArn: str?, FileId: str?, CreationTime: str?, FileStatus: str?, CreatedBy: CreatedByInfo?{ConnectUserArn: str?, AWSIdentityArn: str?}, UploadUrlMetadata: UploadUrlMetadata?{Url: str?, UrlExpiry: str?, HeadersToInclude: map<str, str>?: any}}\n\n@endgroup\n\n@group contact\n@endpoint PUT /contact/chat\n@desc Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.  A 429 error occurs in the following situations:   API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.   The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.   If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.  For more information about chat, see the following topics in the Amazon Connect Administrator Guide:     Concepts: Web and mobile messaging capabilities in Amazon Connect     Amazon Connect Chat security best practices\n@required {InstanceId: str, ContactFlowId: str, ParticipantDetails: ParticipantDetails}\n@optional {Attributes: map<str,str>, InitialMessage: ChatMessage, ClientToken: str, ChatDurationInMinutes: int, SupportedMessagingContentTypes: [str], PersistentChat: PersistentChat, RelatedContactId: str, SegmentAttributes: map<str,SegmentAttributeValue>}\n@returns(200) {ContactId: str?, ParticipantId: str?, ParticipantToken: str?, ContinuedFromContactId: str?}\n\n@endgroup\n\n@group contact-evaluations\n@endpoint PUT /contact-evaluations/{InstanceId}\n@desc Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started.   Evaluations created through the public API do not contain answer values suggested from automation.\n@required {InstanceId: str, ContactId: str, EvaluationFormId: str}\n@optional {ClientToken: str}\n@returns(200) {EvaluationId: str, EvaluationArn: str}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/start-recording\n@desc Starts recording the contact:    If the API is called before the agent joins the call, recording starts when the agent joins the call.   If the API is called after the agent joins the call, recording starts at the time of the API call.   StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time.\n@required {InstanceId: str, ContactId: str, InitialContactId: str, VoiceRecordingConfiguration: VoiceRecordingConfiguration}\n\n@endpoint POST /contact/start-streaming\n@desc Initiates real-time message streaming for a new chat contact.  For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide. For more information about chat, see the following topics in the Amazon Connect Administrator Guide:     Concepts: Web and mobile messaging capabilities in Amazon Connect     Amazon Connect Chat security best practices\n@required {InstanceId: str, ContactId: str, ChatStreamingConfiguration: ChatStreamingConfiguration, ClientToken: str}\n@returns(200) {StreamingId: str}\n\n@endpoint PUT /contact/outbound-voice\n@desc Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId). Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.  UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.    Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.\n@required {DestinationPhoneNumber: str, ContactFlowId: str, InstanceId: str}\n@optional {Name: str, Description: str, References: map<str,Reference>, RelatedContactId: str, ClientToken: str, SourcePhoneNumber: str, QueueId: str, Attributes: map<str,str>, AnswerMachineDetectionConfig: AnswerMachineDetectionConfig, CampaignId: str, TrafficType: str}\n@returns(200) {ContactId: str?}\n\n@endpoint PUT /contact/task\n@desc Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.  When using PreviousContactId and RelatedContactId input parameters, note the following:    PreviousContactId    Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.   There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.      RelatedContactId    Copies contact attributes from the related task contact to the new contact.   Any update on attributes in a new task contact does not update attributes on previous contact.   There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.     In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created. A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.\n@required {InstanceId: str, Name: str}\n@optional {PreviousContactId: str, ContactFlowId: str, Attributes: map<str,str>, References: map<str,Reference>, Description: str, ClientToken: str, ScheduledTime: str(timestamp), TaskTemplateId: str, QuickConnectId: str, RelatedContactId: str}\n@returns(200) {ContactId: str?}\n\n@endpoint PUT /contact/webrtc\n@desc Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).\n@required {ContactFlowId: str, InstanceId: str, ParticipantDetails: ParticipantDetails}\n@optional {Attributes: map<str,str>, ClientToken: str, AllowedCapabilities: AllowedCapabilities, RelatedContactId: str, References: map<str,Reference>, Description: str}\n@returns(200) {ConnectionData: ConnectionData?{Attendee: Attendee?{AttendeeId: str?, JoinToken: str?}, Meeting: Meeting?{MediaRegion: str?, MediaPlacement: MediaPlacement?{AudioHostUrl: str?, AudioFallbackUrl: str?, SignalingUrl: str?, TurnControlUrl: str?, EventIngestionUrl: str?}, MeetingFeatures: MeetingFeaturesConfiguration?{Audio: AudioFeatures?}, MeetingId: str?}}, ContactId: str?, ParticipantId: str?, ParticipantToken: str?}\n\n@endpoint POST /contact/stop\n@desc Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:   DISCONNECT   TRANSFER   QUEUE_TRANSFER   EXTERNAL_OUTBOUND   MONITOR   Chat and task contacts can be terminated in any state, regardless of initiation method.\n@required {ContactId: str, InstanceId: str}\n@optional {DisconnectReason: DisconnectReason}\n\n@endpoint POST /contact/stop-recording\n@desc Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time.\n@required {InstanceId: str, ContactId: str, InitialContactId: str}\n\n@endpoint POST /contact/stop-streaming\n@desc Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.\n@required {InstanceId: str, ContactId: str, StreamingId: str}\n\n@endgroup\n\n@group contact-evaluations\n@endpoint POST /contact-evaluations/{InstanceId}/{EvaluationId}/submit\n@desc Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({}) to the question identifier.  If a contact evaluation is already in submitted state, this operation will trigger a resubmission.\n@required {InstanceId: str, EvaluationId: str}\n@optional {Answers: map<str,EvaluationAnswerInput>, Notes: map<str,EvaluationNote>}\n@returns(200) {EvaluationId: str, EvaluationArn: str}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/suspend-recording\n@desc When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in the final recording. Voice and screen recordings are supported.\n@required {InstanceId: str, ContactId: str, InitialContactId: str}\n\n@endpoint POST /contact/tags\n@desc Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.\n@required {ContactId: str, InstanceId: str, Tags: map<str,str>}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{resourceArn}\n@desc Adds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see Tagging resources in Amazon Connect. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.\n@required {resourceArn: str, tags: map<str,str>}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/transfer\n@desc Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. Note the following requirements:   Transfer is supported for only TASK contacts.   Do not use both QueueId and UserId in the same call.   The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.   The TransferContact API can be called only on active contacts.   A contact cannot be transferred more than 11 times.\n@required {InstanceId: str, ContactId: str, ContactFlowId: str}\n@optional {QueueId: str, UserId: str, ClientToken: str}\n@returns(200) {ContactId: str?, ContactArn: str?}\n\n@endpoint DELETE /contact/tags/{InstanceId}/{ContactId}\n@desc Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.\n@required {ContactId: str, InstanceId: str, TagKeys: [str]}\n\n@endgroup\n\n@group tags\n@endpoint DELETE /tags/{resourceArn}\n@desc Removes the specified tags from the specified resource.\n@required {resourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group agent-status\n@endpoint POST /agent-status/{InstanceId}/{AgentStatusId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates agent status.\n@required {InstanceId: str, AgentStatusId: str}\n@optional {Name: str, Description: str, State: str, DisplayOrder: int, ResetOrderNumber: bool}\n\n@endgroup\n\n@group authentication-profiles\n@endpoint POST /authentication-profiles/{InstanceId}/{AuthenticationProfileId}\n@desc This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile.\n@required {AuthenticationProfileId: str, InstanceId: str}\n@optional {Name: str, Description: str, AllowedIps: [str], BlockedIps: [str], PeriodicSessionDuration: int}\n\n@endgroup\n\n@group contacts\n@endpoint POST /contacts/{InstanceId}/{ContactId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.  You can add or update user-defined contact information for both ongoing and completed contacts.\n@required {InstanceId: str, ContactId: str}\n@optional {Name: str, Description: str, References: map<str,Reference>}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/attributes\n@desc Creates or updates user-defined contact attributes associated with the specified contact. You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also 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 to identify abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see Feature specifications in the Amazon Connect Administrator Guide.\n@required {InitialContactId: str, InstanceId: str, Attributes: map<str,str>}\n\n@endgroup\n\n@group contact-evaluations\n@endpoint POST /contact-evaluations/{InstanceId}/{EvaluationId}\n@desc Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.\n@required {InstanceId: str, EvaluationId: str}\n@optional {Answers: map<str,EvaluationAnswerInput>, Notes: map<str,EvaluationNote>}\n@returns(200) {EvaluationId: str, EvaluationArn: str}\n\n@endgroup\n\n@group contact-flows\n@endpoint POST /contact-flows/{InstanceId}/{ContactFlowId}/content\n@desc Updates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.\n@required {InstanceId: str, ContactFlowId: str, Content: str}\n\n@endpoint POST /contact-flows/{InstanceId}/{ContactFlowId}/metadata\n@desc Updates metadata about specified flow.\n@required {InstanceId: str, ContactFlowId: str}\n@optional {Name: str, Description: str, ContactFlowState: str}\n\n@endgroup\n\n@group contact-flow-modules\n@endpoint POST /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content\n@desc Updates specified flow module for the specified Amazon Connect instance.  Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.\n@required {InstanceId: str, ContactFlowModuleId: str, Content: str}\n\n@endpoint POST /contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/metadata\n@desc Updates metadata about specified flow module.\n@required {InstanceId: str, ContactFlowModuleId: str}\n@optional {Name: str, Description: str, State: str}\n\n@endgroup\n\n@group contact-flows\n@endpoint POST /contact-flows/{InstanceId}/{ContactFlowId}/name\n@desc The name of the flow. You can also create and update flows using the Amazon Connect Flow language.\n@required {InstanceId: str, ContactFlowId: str}\n@optional {Name: str, Description: str}\n\n@endgroup\n\n@group contacts\n@endpoint POST /contacts/{InstanceId}/{ContactId}/routing-data\n@desc Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using the Set routing priority / age flow block.  Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not both.\n@required {InstanceId: str, ContactId: str}\n@optional {QueueTimeAdjustmentSeconds: int, QueuePriority: int(i64), RoutingCriteria: RoutingCriteriaInput}\n\n@endgroup\n\n@group contact\n@endpoint POST /contact/schedule\n@desc Updates the scheduled time of a task contact that is already scheduled.\n@required {InstanceId: str, ContactId: str, ScheduledTime: str(timestamp)}\n\n@endgroup\n\n@group evaluation-forms\n@endpoint PUT /evaluation-forms/{InstanceId}/{EvaluationFormId}\n@desc Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content.\n@required {InstanceId: str, EvaluationFormId: str, EvaluationFormVersion: int, Title: str, Items: [EvaluationFormItem]}\n@optional {CreateNewVersion: bool, Description: str, ScoringStrategy: EvaluationFormScoringStrategy, ClientToken: str}\n@returns(200) {EvaluationFormId: str, EvaluationFormArn: str, EvaluationFormVersion: int}\n\n@endgroup\n\n@group hours-of-operations\n@endpoint POST /hours-of-operations/{InstanceId}/{HoursOfOperationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation.\n@required {InstanceId: str, HoursOfOperationId: str}\n@optional {Name: str, Description: str, TimeZone: str, Config: [HoursOfOperationConfig]}\n\n@endgroup\n\n@group instance\n@endpoint POST /instance/{InstanceId}/attribute/{AttributeType}\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type.\n@required {InstanceId: str, AttributeType: str, Value: str}\n\n@endpoint POST /instance/{InstanceId}/storage-config/{AssociationId}\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates an existing configuration for a resource type. This API is idempotent.\n@required {InstanceId: str, AssociationId: str, resourceType: str, StorageConfig: InstanceStorageConfig}\n\n@endgroup\n\n@group contact\n@endpoint PUT /contact/participant-role-config/{InstanceId}/{ContactId}\n@desc Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:   Customer idle timeout   Customer auto-disconnect timeout   Agent idle timeout   Agent auto-disconnect timeout   For more information about how chat timeouts work, see Set up chat timeouts for human participants.\n@required {InstanceId: str, ContactId: str, ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo}\n\n@endgroup\n\n@group phone-number\n@endpoint PUT /phone-number/{PhoneNumberId}\n@desc Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.  After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.\n@required {PhoneNumberId: str}\n@optional {TargetArn: str, InstanceId: str, ClientToken: str}\n@returns(200) {PhoneNumberId: str?, PhoneNumberArn: str?}\n\n@endpoint PUT /phone-number/{PhoneNumberId}/metadata\n@desc Updates a phone number’s metadata.  To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.\n@required {PhoneNumberId: str}\n@optional {PhoneNumberDescription: str, ClientToken: str}\n\n@endgroup\n\n@group predefined-attributes\n@endpoint POST /predefined-attributes/{InstanceId}/{Name}\n@desc Updates a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.\n@required {InstanceId: str, Name: str}\n@optional {Values: PredefinedAttributeValues}\n\n@endgroup\n\n@group prompts\n@endpoint POST /prompts/{InstanceId}/{PromptId}\n@desc Updates a prompt.\n@required {InstanceId: str, PromptId: str}\n@optional {Name: str, Description: str, S3Uri: str}\n@returns(200) {PromptARN: str?, PromptId: str?}\n\n@endgroup\n\n@group queues\n@endpoint POST /queues/{InstanceId}/{QueueId}/hours-of-operation\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the hours of operation for the specified queue.\n@required {InstanceId: str, QueueId: str, HoursOfOperationId: str}\n\n@endpoint POST /queues/{InstanceId}/{QueueId}/max-contacts\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the maximum number of contacts allowed in a queue before it is considered full.\n@required {InstanceId: str, QueueId: str}\n@optional {MaxContacts: int}\n\n@endpoint POST /queues/{InstanceId}/{QueueId}/name\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the name and description of a queue. At least Name or Description must be provided.\n@required {InstanceId: str, QueueId: str}\n@optional {Name: str, Description: str}\n\n@endpoint POST /queues/{InstanceId}/{QueueId}/outbound-caller-config\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.    If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.   Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.   If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.\n@required {InstanceId: str, QueueId: str, OutboundCallerConfig: OutboundCallerConfig}\n\n@endpoint POST /queues/{InstanceId}/{QueueId}/status\n@desc This API is in preview release for Amazon Connect and is subject to change. Updates the status of the queue.\n@required {InstanceId: str, QueueId: str, Status: str}\n\n@endgroup\n\n@group quick-connects\n@endpoint POST /quick-connects/{InstanceId}/{QuickConnectId}/config\n@desc Updates the configuration settings for the specified quick connect.\n@required {InstanceId: str, QuickConnectId: str, QuickConnectConfig: QuickConnectConfig}\n\n@endpoint POST /quick-connects/{InstanceId}/{QuickConnectId}/name\n@desc Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.\n@required {InstanceId: str, QuickConnectId: str}\n@optional {Name: str, Description: str}\n\n@endgroup\n\n@group routing-profiles\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer\n@desc Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.\n@required {InstanceId: str, RoutingProfileId: str, AgentAvailabilityTimer: str}\n\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency\n@desc Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.\n@required {InstanceId: str, RoutingProfileId: str, MediaConcurrencies: [MediaConcurrency]}\n\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue\n@desc Updates the default outbound queue of a routing profile.\n@required {InstanceId: str, RoutingProfileId: str, DefaultOutboundQueueId: str}\n\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/name\n@desc Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.\n@required {InstanceId: str, RoutingProfileId: str}\n@optional {Name: str, Description: str}\n\n@endpoint POST /routing-profiles/{InstanceId}/{RoutingProfileId}/queues\n@desc Updates the properties associated with a set of queues for a routing profile.\n@required {InstanceId: str, RoutingProfileId: str, QueueConfigs: [RoutingProfileQueueConfig]}\n\n@endgroup\n\n@group rules\n@endpoint PUT /rules/{InstanceId}/{RuleId}\n@desc Updates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.\n@required {RuleId: str, InstanceId: str, Name: str, Function: str, Actions: [RuleAction], PublishStatus: str}\n\n@endgroup\n\n@group security-profiles\n@endpoint POST /security-profiles/{InstanceId}/{SecurityProfileId}\n@desc Updates 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.\n@required {SecurityProfileId: str, InstanceId: str}\n@optional {Description: str, Permissions: [str], AllowedAccessControlTags: map<str,str>, TagRestrictedResources: [str], Applications: [Application], HierarchyRestrictedResources: [str], AllowedAccessControlHierarchyGroupId: str}\n\n@endgroup\n\n@group instance\n@endpoint POST /instance/{InstanceId}/task/template/{TaskTemplateId}\n@desc Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.\n@required {TaskTemplateId: str, InstanceId: str}\n@optional {Name: str, Description: str, ContactFlowId: str, Constraints: TaskTemplateConstraints, Defaults: TaskTemplateDefaults, Status: str, Fields: [TaskTemplateField]}\n@returns(200) {InstanceId: str?, Id: str?, Arn: str?, Name: str?, Description: str?, ContactFlowId: str?, Constraints: TaskTemplateConstraints?{RequiredFields: [RequiredFieldInfo]?, ReadOnlyFields: [ReadOnlyFieldInfo]?, InvisibleFields: [InvisibleFieldInfo]?}, Defaults: TaskTemplateDefaults?{DefaultFieldValues: [TaskTemplateDefaultFieldValue]?}, Fields: [TaskTemplateField]?, Status: str?, LastModifiedTime: str(timestamp)?, CreatedTime: str(timestamp)?}\n\n@endgroup\n\n@group traffic-distribution\n@endpoint PUT /traffic-distribution/{Id}\n@desc Updates the traffic distribution for a given traffic distribution group.   The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.  For more information about updating a traffic distribution group, see Update telephony traffic distribution across Amazon Web Services Regions  in the Amazon Connect Administrator Guide.\n@required {Id: str}\n@optional {TelephonyConfig: TelephonyConfig, SignInConfig: SignInConfig, AgentConfig: AgentConfig}\n\n@endgroup\n\n@group users\n@endpoint POST /users/{InstanceId}/{UserId}/hierarchy\n@desc Assigns the specified hierarchy group to the specified user.\n@required {UserId: str, InstanceId: str}\n@optional {HierarchyGroupId: str}\n\n@endgroup\n\n@group user-hierarchy-groups\n@endpoint POST /user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}/name\n@desc Updates the name of the user hierarchy group.\n@required {HierarchyGroupId: str, InstanceId: str, Name: str}\n\n@endgroup\n\n@group user-hierarchy-structure\n@endpoint POST /user-hierarchy-structure/{InstanceId}\n@desc Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.\n@required {InstanceId: str, HierarchyStructure: HierarchyStructureUpdate}\n\n@endgroup\n\n@group users\n@endpoint POST /users/{InstanceId}/{UserId}/identity-info\n@desc Updates the identity information for the specified user.  We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.\n@required {UserId: str, InstanceId: str, IdentityInfo: UserIdentityInfo}\n\n@endpoint POST /users/{InstanceId}/{UserId}/phone-config\n@desc Updates the phone configuration settings for the specified user.\n@required {UserId: str, InstanceId: str, PhoneConfig: UserPhoneConfig}\n\n@endpoint POST /users/{InstanceId}/{UserId}/proficiencies\n@desc Updates the properties associated with the proficiencies of a user.\n@required {InstanceId: str, UserId: str, UserProficiencies: [UserProficiency]}\n\n@endpoint POST /users/{InstanceId}/{UserId}/routing-profile\n@desc Assigns the specified routing profile to the specified user.\n@required {UserId: str, InstanceId: str, RoutingProfileId: str}\n\n@endpoint POST /users/{InstanceId}/{UserId}/security-profiles\n@desc Assigns the specified security profiles to the specified user.\n@required {UserId: str, InstanceId: str, SecurityProfileIds: [str]}\n\n@endgroup\n\n@group views\n@endpoint POST /views/{InstanceId}/{ViewId}\n@desc Updates the view content of the given view identifier in the specified Amazon Connect instance. It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.\n@required {InstanceId: str, ViewId: str, Status: str, Content: ViewInputContent}\n@returns(200) {View: View?{Id: str?, Arn: str?, Name: str?, Status: str?, Type: str?, Description: str?, Version: int?, VersionDescription: str?, Content: ViewContent?{InputSchema: str?, Template: str?, Actions: [str]?}, Tags: map<str, str>?: any, CreatedTime: str(timestamp)?, LastModifiedTime: str(timestamp)?, ViewContentSha256: str?}}\n\n@endpoint POST /views/{InstanceId}/{ViewId}/metadata\n@desc Updates the view metadata. Note that either Name or Description must be provided.\n@required {InstanceId: str, ViewId: str}\n@optional {Name: str, Description: str}\n\n@endgroup\n\n@end\n"}}