Amazon Connect Service

Amazon Connect Service API skill. Use when working with Amazon Connect Service for evaluation-forms, analytics-data, instance. Covers 255 endpoints.

Lap-Platform Updated Sep 9, 2026 6 repo stars

Data & Analytics

Install

Press C to copy

$ npx skillmds@latest add lap-platform/amazon-connect-service

Installs into ~/.claude/skills (or .claude/skills inside a project). Restart Claude Code to pick it up.

＋ Add to plugin

README badge

[![SkillMD](https://skillmd.com/badge/lap-platform/amazon-connect-service.svg)](https://skillmd.com/skills/lap-platform/amazon-connect-service)

Trust & safety

2 of 3 audits passed

Last audited Sep 24, 2026 · commit 794b831

Permissions this skill uses

Makes network calls
The instructions fetch remote URLs or call external services.
Reads secrets
The instructions read tokens, keys, or other credentials.

Works with: Claude Code Claude.ai OpenAI Codex +

File contents

Amazon Connect Service

API version: 2017-08-08

Auth

AWS SigV4

Base URL

Not specified.

Setup

Configure auth: AWS SigV4
GET /instance -- verify access
POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate -- create first activate

Endpoints

255 endpoints across 66 groups. See references/api-spec.lap for full details.

evaluation-forms

Method	Path	Description
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.
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.
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.
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.
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.
GET	/evaluation-forms/{InstanceId}/{EvaluationFormId}/versions	Lists versions of an evaluation form in the specified Amazon Connect instance.
GET	/evaluation-forms/{InstanceId}	Lists evaluation forms in the specified Amazon Connect instance.
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.

analytics-data

Method	Path	Description
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.
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.
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.
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.
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.

instance

Method	Path	Description
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.
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.
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.
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.
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.
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.
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.
PUT	/instance/{InstanceId}/integration-associations	Creates an Amazon Web Services resource association with an Amazon Connect instance.
PUT	/instance/{InstanceId}/task/template	Creates a new task template in the specified Amazon Connect instance.
PUT	/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases	Creates a use case for an integration association.
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.
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.
DELETE	/instance/{InstanceId}/task/template/{TaskTemplateId}	Deletes the task template.
DELETE	/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}	Deletes a use case from an integration association.
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.
GET	/instance/{InstanceId}/attribute/{AttributeType}	This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.
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.
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.
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.
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.
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.
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.
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.
GET	/instance/{InstanceId}/task/template/{TaskTemplateId}	Gets details about a specific task template in the specified Amazon Connect instance.
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.
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.
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.
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.
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.
GET	/instance/{InstanceId}/integration-associations	Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
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.
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.
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.
GET	/instance/{InstanceId}/task/template	Lists task templates for the specified Amazon Connect instance.
GET	/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases	Lists the use cases for the integration association.
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.
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.
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.
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.

default-vocabulary

Method	Path	Description
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.

flow-associations

Method	Path	Description
PUT	/flow-associations/{InstanceId}	Associates a connect resource to a flow.
DELETE	/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}	Disassociates a connect resource from a flow.
GET	/flow-associations/{InstanceId}/{ResourceId}/{ResourceType}	Retrieves the flow associated for a given resource.

phone-number

Method	Path	Description
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.
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.
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.
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.
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.
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.
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.
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.
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.
PUT	/phone-number/{PhoneNumberId}/metadata	Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

queues

Method	Path	Description
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.
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.
DELETE	/queues/{InstanceId}/{QueueId}	Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
GET	/queues/{InstanceId}/{QueueId}	This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue.
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.
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.
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.
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.
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.
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.
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.

routing-profiles

Method	Path	Description
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues	Associates a set of queues with a routing profile.
PUT	/routing-profiles/{InstanceId}	Creates a new routing profile.
DELETE	/routing-profiles/{InstanceId}/{RoutingProfileId}	Deletes a routing profile.
GET	/routing-profiles/{InstanceId}/{RoutingProfileId}	Describes the specified routing profile.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues	Disassociates a set of queues from a routing profile.
GET	/routing-profiles/{InstanceId}/{RoutingProfileId}/queues	Lists the queues associated with a routing profile.
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.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency	Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue	Updates the default outbound queue of a routing profile.
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.
POST	/routing-profiles/{InstanceId}/{RoutingProfileId}/queues	Updates the properties associated with a set of queues for a routing profile.

traffic-distribution-group

Method	Path	Description
PUT	/traffic-distribution-group/{TrafficDistributionGroupId}/user	Associates an agent with a traffic distribution group.
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.
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.
GET	/traffic-distribution-group/{TrafficDistributionGroupId}	Gets details and status of a traffic distribution group.
DELETE	/traffic-distribution-group/{TrafficDistributionGroupId}/user	Disassociates an agent from a traffic distribution group.
GET	/traffic-distribution-group/{TrafficDistributionGroupId}/user	Lists traffic distribution group users.

users

Method	Path	Description
POST	/users/{InstanceId}/{UserId}/associate-proficiencies	>Associates a set of proficiencies with a user.
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.
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.
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.
POST	/users/{InstanceId}/{UserId}/disassociate-proficiencies	Disassociates a set of proficiencies from a user.
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.
GET	/users/{InstanceId}/{UserId}/proficiencies	Lists proficiencies associated with a user.
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.
POST	/users/{InstanceId}/{UserId}/hierarchy	Assigns the specified hierarchy group to the specified user.
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.
POST	/users/{InstanceId}/{UserId}/phone-config	Updates the phone configuration settings for the specified user.
POST	/users/{InstanceId}/{UserId}/proficiencies	Updates the properties associated with the proficiencies of a user.
POST	/users/{InstanceId}/{UserId}/routing-profile	Assigns the specified routing profile to the specified user.
POST	/users/{InstanceId}/{UserId}/security-profiles	Assigns the specified security profiles to the specified user.

attached-files

Method	Path	Description
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.
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.
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.
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.
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.

flow-associations-batch

Method	Path	Description
POST	/flow-associations-batch/{InstanceId}	Retrieve the flow associations for the given resources.

contact

Method	Path	Description
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.
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.
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.
GET	/contact/attributes/{InstanceId}/{InitialContactId}	Retrieves the contact attributes for the specified contact.
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.
POST	/contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId}	Provides a list of analysis segments for a real-time analysis session.
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.
POST	/contact/pause	Allows pausing an ongoing task contact.
POST	/contact/resume	Allows resuming a task contact in a paused state.
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.
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
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 S

…(truncated)

---name: amazon-connect-servicedescription: Amazon Connect Service API skill. Use when working with Amazon Connect Service for evaluation-forms, analytics-data, instance. Covers 255 endpoints.--- # Amazon Connect Service API version: 2017-08-08 ## Auth AWS SigV4 ## Base URL Not specified. ## Setup 1. Configure auth: AWS SigV4 2. GET /instance -- verify access 3. POST /evaluation-forms/{InstanceId}/{EvaluationFormId}/activate -- create first activate ## Endpoints 255 endpoints across 66 groups. See references/api-spec.lap for full details. ### evaluation-forms | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | 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. | | 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. | | 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. | | GET | /evaluation-forms/{InstanceId}/{EvaluationFormId}/versions | Lists versions of an evaluation form in the specified Amazon Connect instance. | | GET | /evaluation-forms/{InstanceId} | Lists evaluation forms in the specified Amazon Connect instance. | | 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. | ### analytics-data | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | 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. | | 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. | | 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. | ### instance | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | PUT | /instance/{InstanceId}/integration-associations | Creates an Amazon Web Services resource association with an Amazon Connect instance. | | PUT | /instance/{InstanceId}/task/template | Creates a new task template in the specified Amazon Connect instance. | | PUT | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases | Creates a use case for an integration association. | | 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. | | 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. | | DELETE | /instance/{InstanceId}/task/template/{TaskTemplateId} | Deletes the task template. | | DELETE | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId} | Deletes a use case from an integration association. | | 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. | | GET | /instance/{InstanceId}/attribute/{AttributeType} | This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | GET | /instance/{InstanceId}/task/template/{TaskTemplateId} | Gets details about a specific task template in the specified Amazon Connect instance. | | 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. | | 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. | | 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. | | 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. | | 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. | | GET | /instance/{InstanceId}/integration-associations | Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance. | | 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. | | 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. | | 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. | | GET | /instance/{InstanceId}/task/template | Lists task templates for the specified Amazon Connect instance. | | GET | /instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases | Lists the use cases for the integration association. | | 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. | | 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. | | 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. | | 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. | ### default-vocabulary | Method | Path | Description | |--------|------|-------------| | 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. | ### flow-associations | Method | Path | Description | |--------|------|-------------| | PUT | /flow-associations/{InstanceId} | Associates a connect resource to a flow. | | DELETE | /flow-associations/{InstanceId}/{ResourceId}/{ResourceType} | Disassociates a connect resource from a flow. | | GET | /flow-associations/{InstanceId}/{ResourceId}/{ResourceType} | Retrieves the flow associated for a given resource. | ### phone-number | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | PUT | /phone-number/{PhoneNumberId}/metadata | Updates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API. | ### queues | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | DELETE | /queues/{InstanceId}/{QueueId} | Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website. | | GET | /queues/{InstanceId}/{QueueId} | This API is in preview release for Amazon Connect and is subject to change. Describes the specified queue. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | ### routing-profiles | Method | Path | Description | |--------|------|-------------| | POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/associate-queues | Associates a set of queues with a routing profile. | | PUT | /routing-profiles/{InstanceId} | Creates a new routing profile. | | DELETE | /routing-profiles/{InstanceId}/{RoutingProfileId} | Deletes a routing profile. | | GET | /routing-profiles/{InstanceId}/{RoutingProfileId} | Describes the specified routing profile. | | POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/disassociate-queues | Disassociates a set of queues from a routing profile. | | GET | /routing-profiles/{InstanceId}/{RoutingProfileId}/queues | Lists the queues associated with a routing profile. | | 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. | | POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/concurrency | Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile. | | POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/default-outbound-queue | Updates the default outbound queue of a routing profile. | | 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. | | POST | /routing-profiles/{InstanceId}/{RoutingProfileId}/queues | Updates the properties associated with a set of queues for a routing profile. | ### traffic-distribution-group | Method | Path | Description | |--------|------|-------------| | PUT | /traffic-distribution-group/{TrafficDistributionGroupId}/user | Associates an agent with a traffic distribution group. | | 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. | | 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. | | GET | /traffic-distribution-group/{TrafficDistributionGroupId} | Gets details and status of a traffic distribution group. | | DELETE | /traffic-distribution-group/{TrafficDistributionGroupId}/user | Disassociates an agent from a traffic distribution group. | | GET | /traffic-distribution-group/{TrafficDistributionGroupId}/user | Lists traffic distribution group users. | ### users | Method | Path | Description | |--------|------|-------------| | POST | /users/{InstanceId}/{UserId}/associate-proficiencies | >Associates a set of proficiencies with a user. | | 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. | | 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. | | 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. | | POST | /users/{InstanceId}/{UserId}/disassociate-proficiencies | Disassociates a set of proficiencies from a user. | | 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. | | GET | /users/{InstanceId}/{UserId}/proficiencies | Lists proficiencies associated with a user. | | 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. | | POST | /users/{InstanceId}/{UserId}/hierarchy | Assigns the specified hierarchy group to the specified user. | | 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. | | POST | /users/{InstanceId}/{UserId}/phone-config | Updates the phone configuration settings for the specified user. | | POST | /users/{InstanceId}/{UserId}/proficiencies | Updates the properties associated with the proficiencies of a user. | | POST | /users/{InstanceId}/{UserId}/routing-profile | Assigns the specified routing profile to the specified user. | | POST | /users/{InstanceId}/{UserId}/security-profiles | Assigns the specified security profiles to the specified user. | ### attached-files | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | 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. | | 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. | | 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. | ### flow-associations-batch | Method | Path | Description | |--------|------|-------------| | POST | /flow-associations-batch/{InstanceId} | Retrieve the flow associations for the given resources. | ### contact | Method | Path | Description | |--------|------|-------------| | 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. | | 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. | | 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. | | GET | /contact/attributes/{InstanceId}/{InitialContactId} | Retrieves the contact attributes for the specified contact. | | 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. | | POST | /contact/list-real-time-analysis-segments-v2/{InstanceId}/{ContactId} | Provides a list of analysis segments for a real-time analysis session. | | 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. | | POST | /contact/pause | Allows pausing an ongoing task contact. | | POST | /contact/resume | Allows resuming a task contact in a paused state. | | 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. | | 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 | | 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 S …(truncated)

Lap-Platform/claude-marketplace/tree/main/plugins/amazonaws-com-amazonaws-com-connect/skills/api commit 794b83185d

Frequently asked questions

npx skillmds@latest add lap-platform/amazon-connect-service