Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Working with contact flows? Check out the Amazon Connect Flow language.
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
Working with flows? Check out the Amazon Connect Flow language.
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
", "AssociateBot": "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.
", @@ -8,14 +8,14 @@ "AssociateInstanceStorageConfig": "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.
", "AssociateLambdaFunction": "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.
", "AssociateLexBot": "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 bot.
", - "AssociatePhoneNumberContactFlow": "Associates a contact flow with a phone number claimed to your Amazon Connect instance.
", + "AssociatePhoneNumberContactFlow": "Associates a flow with a phone number claimed to your Amazon Connect instance.
", "AssociateQueueQuickConnects": "This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
", "AssociateRoutingProfileQueues": "Associates a set of queues with a routing profile.
", "AssociateSecurityKey": "This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
", "ClaimPhoneNumber": "Claims an available phone number to your Amazon Connect instance.
", "CreateAgentStatus": "This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
", - "CreateContactFlow": "Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
", - "CreateContactFlowModule": "Creates a contact flow module for the specified Amazon Connect instance.
", + "CreateContactFlow": "Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
", + "CreateContactFlowModule": "Creates a flow module for the specified Amazon Connect instance.
", "CreateHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
", "CreateInstance": "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.
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.
", "CreateIntegrationAssociation": "Creates an Amazon Web Services resource association with an Amazon Connect instance.
", @@ -28,8 +28,8 @@ "CreateUser": "Creates a user account for the specified Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
", "CreateUserHierarchyGroup": "Creates a new user hierarchy group.
", "CreateVocabulary": "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.
", - "DeleteContactFlow": "Deletes a contact flow for the specified Amazon Connect instance.
", - "DeleteContactFlowModule": "Deletes the specified contact flow module.
", + "DeleteContactFlow": "Deletes a flow for the specified Amazon Connect instance.
", + "DeleteContactFlowModule": "Deletes the specified flow module.
", "DeleteHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
", "DeleteInstance": "This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
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.
", "DeleteIntegrationAssociation": "Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
", @@ -42,8 +42,8 @@ "DeleteVocabulary": "Deletes the vocabulary that has the given identifier.
", "DescribeAgentStatus": "This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
", "DescribeContact": "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.
Describes the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
", - "DescribeContactFlowModule": "Describes the specified contact flow module.
", + "DescribeContactFlow": "Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
", + "DescribeContactFlowModule": "Describes the specified flow module.
", "DescribeHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
", "DescribeInstance": "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.
", "DescribeInstanceAttribute": "This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
", @@ -60,9 +60,9 @@ "DisassociateApprovedOrigin": "This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
", "DisassociateBot": "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.
", "DisassociateInstanceStorageConfig": "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.
", - "DisassociateLambdaFunction": "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 contact flow blocks.
", + "DisassociateLambdaFunction": "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.
", "DisassociateLexBot": "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.
", - "DisassociatePhoneNumberContactFlow": "Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.
", + "DisassociatePhoneNumberContactFlow": "Removes the flow association from a phone number claimed to your Amazon Connect instance, if a flow association exists.
", "DisassociateQueueQuickConnects": "This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
", "DisassociateRoutingProfileQueues": "Disassociates a set of queues from a routing profile.
", "DisassociateSecurityKey": "This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
", @@ -75,8 +75,8 @@ "ListAgentStatuses": "This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
", "ListApprovedOrigins": "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.
", "ListBots": "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.
", - "ListContactFlowModules": "Provides information about the contact flow modules for the specified Amazon Connect instance.
", - "ListContactFlows": "Provides information about the contact flows for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.
", + "ListContactFlowModules": "Provides information about the flow modules for the specified Amazon Connect instance.
", + "ListContactFlows": "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.
", "ListContactReferences": "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.
Lists the default vocabularies for the specified Amazon Connect instance.
", "ListHoursOfOperations": "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.
", @@ -84,7 +84,7 @@ "ListInstanceStorageConfigs": "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.
", "ListInstances": "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.
", "ListIntegrationAssociations": "Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
", - "ListLambdaFunctions": "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 contact flow blocks.
", + "ListLambdaFunctions": "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.
", "ListLexBots": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
", "ListPhoneNumbers": "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.
", "ListPhoneNumbersV2": "Lists phone numbers claimed to your Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
", @@ -106,28 +106,29 @@ "ReleasePhoneNumber": "Releases a phone number previously claimed to an Amazon Connect instance.
", "ResumeContactRecording": "When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
", "SearchAvailablePhoneNumbers": "Searches for available phone numbers that you can claim to your Amazon Connect instance.
", + "SearchSecurityProfiles": "This API is in preview release for Amazon Connect and is subject to change.
Searches security profiles in an Amazon Connect instance, with optional filtering.
", "SearchUsers": "Searches users in an Amazon Connect instance, with optional filtering.
", "SearchVocabularies": "Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
Initiates a contact 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 Chat in the Amazon Connect Administrator Guide.
", + "StartChatContact": "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 Chat in the Amazon Connect Administrator Guide.
", "StartContactRecording": "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.
", "StartContactStreaming": "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.
", - "StartOutboundVoiceContact": "Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact 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. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Initiates a contact flow to start a new task.
", + "StartOutboundVoiceContact": "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.
Initiates a flow to start a new task.
", "StopContact": "Ends the specified contact. This call does not work for the following initiation methods:
DISCONNECT
TRANSFER
QUEUE_TRANSFER
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.
", "StopContactStreaming": "Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.
", "SuspendContactRecording": "When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.
The period of time that the recording is suspended is filled with silence in the final recording.
Only voice recordings are supported at this time.
", - "TagResource": "Adds the specified tags to the specified resource.
The supported resource types are users, routing profiles, queues, quick connects, contact flows, agent status, hours of operation, phone number, security profiles, and task templates.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
", - "TransferContact": "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 contact 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 contact flow types are supported: Inbound contact 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.
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.
", + "TransferContact": "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.
Removes the specified tags from the specified resource.
", "UpdateAgentStatus": "This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
", "UpdateContact": "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.
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 CTR retention and the maximum size of the CTR attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
", - "UpdateContactFlowContent": "Updates the specified contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
", - "UpdateContactFlowMetadata": "Updates metadata about specified contact flow.
", - "UpdateContactFlowModuleContent": "Updates specified contact flow module for the specified Amazon Connect instance.
", - "UpdateContactFlowModuleMetadata": "Updates metadata about specified contact flow module.
", - "UpdateContactFlowName": "The name of the contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
", + "UpdateContactAttributes": "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.
", + "UpdateContactFlowContent": "Updates the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
", + "UpdateContactFlowMetadata": "Updates metadata about specified flow.
", + "UpdateContactFlowModuleContent": "Updates specified flow module for the specified Amazon Connect instance.
", + "UpdateContactFlowModuleMetadata": "Updates metadata about specified flow module.
", + "UpdateContactFlowName": "The name of the flow.
You can also create and update flows using the Amazon Connect Flow language.
", "UpdateContactSchedule": "Updates the scheduled time of a task contact that is already scheduled.
", "UpdateHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Updates the hours of operation.
", "UpdateInstanceAttribute": "This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
", @@ -166,16 +167,16 @@ "ClaimedPhoneNumberSummary$PhoneNumberArn": "The Amazon Resource Name (ARN) of the phone number.
", "ClaimedPhoneNumberSummary$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
", "Contact$Arn": "The Amazon Resource Name (ARN) for the contact.
", - "ContactFlow$Arn": "The Amazon Resource Name (ARN) of the contact flow.
", + "ContactFlow$Arn": "The Amazon Resource Name (ARN) of the flow.
", "ContactFlowModule$Arn": "The Amazon Resource Name (ARN).
", - "ContactFlowModuleSummary$Arn": "The Amazon Resource Name (ARN) of the contact flow module.
", - "ContactFlowSummary$Arn": "The Amazon Resource Name (ARN) of the contact flow.
", + "ContactFlowModuleSummary$Arn": "The Amazon Resource Name (ARN) of the flow module.
", + "ContactFlowSummary$Arn": "The Amazon Resource Name (ARN) of the flow.
", "CreateAgentStatusResponse$AgentStatusARN": "The Amazon Resource Name (ARN) of the agent status.
", - "CreateContactFlowModuleResponse$Arn": "The Amazon Resource Name (ARN) of the contact flow module.
", - "CreateContactFlowResponse$ContactFlowArn": "The Amazon Resource Name (ARN) of the contact flow.
", + "CreateContactFlowModuleResponse$Arn": "The Amazon Resource Name (ARN) of the flow module.
", + "CreateContactFlowResponse$ContactFlowArn": "The Amazon Resource Name (ARN) of the flow.
", "CreateHoursOfOperationResponse$HoursOfOperationArn": "The Amazon Resource Name (ARN) for the hours of operation.
", "CreateInstanceResponse$Arn": "The Amazon Resource Name (ARN) of the instance.
", - "CreateIntegrationAssociationRequest$IntegrationArn": "The Amazon Resource Name (ARN) of the integration.
", + "CreateIntegrationAssociationRequest$IntegrationArn": "The Amazon Resource Name (ARN) of the integration.
When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
The Amazon Resource Name (ARN) for the association.
", "CreateQueueResponse$QueueArn": "The Amazon Resource Name (ARN) of the queue.
", "CreateQuickConnectResponse$QuickConnectARN": "The Amazon Resource Name (ARN) for the quick connect.
", @@ -218,6 +219,7 @@ "RoutingProfileSummary$Arn": "The Amazon Resource Name (ARN) of the routing profile.
", "SearchAvailablePhoneNumbersRequest$TargetArn": "The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
", "SecurityProfile$Arn": "The Amazon Resource Name (ARN) for the secruity profile.
", + "SecurityProfileSearchSummary$Arn": "The Amazon Resource Name (ARN) of the security profile.
", "SecurityProfileSummary$Arn": "The Amazon Resource Name (ARN) of the security profile.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TransferContactResponse$ContactArn": "The Amazon Resource Name (ARN) of the contact.
", @@ -388,6 +390,7 @@ "ApproximateTotalCount": { "base": null, "refs": { + "SearchSecurityProfilesResponse$ApproximateTotalCount": "The total number of security profiles which matched your search query.
", "SearchUsersResponse$ApproximateTotalCount": "The total number of users who matched your search query.
" } }, @@ -498,10 +501,10 @@ "base": null, "refs": { "GetContactAttributesResponse$Attributes": "Information about the attributes.
", - "StartChatContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in contact flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", - "StartOutboundVoiceContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", - "StartTaskContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", - "UpdateContactAttributesRequest$Attributes": "The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
" + "StartChatContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", + "StartOutboundVoiceContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", + "StartTaskContactRequest$Attributes": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
", + "UpdateContactAttributesRequest$Attributes": "The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
" } }, "AttributesList": { @@ -687,113 +690,113 @@ } }, "ContactFlow": { - "base": "Contains information about a contact flow.
", + "base": "Contains information about a flow.
", "refs": { - "DescribeContactFlowResponse$ContactFlow": "Information about the contact flow.
" + "DescribeContactFlowResponse$ContactFlow": "Information about the flow.
" } }, "ContactFlowContent": { "base": null, "refs": { - "ContactFlow$Content": "The content of the contact flow.
", - "CreateContactFlowRequest$Content": "The content of the contact flow.
", - "UpdateContactFlowContentRequest$Content": "The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.
" + "ContactFlow$Content": "The content of the flow.
", + "CreateContactFlowRequest$Content": "The content of the flow.
", + "UpdateContactFlowContentRequest$Content": "The JSON string that represents flow's content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.
" } }, "ContactFlowDescription": { "base": null, "refs": { - "ContactFlow$Description": "The description of the contact flow.
", - "CreateContactFlowRequest$Description": "The description of the contact flow.
", - "UpdateContactFlowMetadataRequest$Description": "The description of the contact flow.
", - "UpdateContactFlowNameRequest$Description": "The description of the contact flow.
" + "ContactFlow$Description": "The description of the flow.
", + "CreateContactFlowRequest$Description": "The description of the flow.
", + "UpdateContactFlowMetadataRequest$Description": "The description of the flow.
", + "UpdateContactFlowNameRequest$Description": "The description of the flow.
" } }, "ContactFlowId": { "base": null, "refs": { - "AssociatePhoneNumberContactFlowRequest$ContactFlowId": "The identifier of the contact flow.
", - "ContactFlow$Id": "The identifier of the contact flow.
", - "ContactFlowSummary$Id": "The identifier of the contact flow.
", - "CreateContactFlowResponse$ContactFlowId": "The identifier of the contact flow.
", + "AssociatePhoneNumberContactFlowRequest$ContactFlowId": "The identifier of the flow.
", + "ContactFlow$Id": "The identifier of the flow.
", + "ContactFlowSummary$Id": "The identifier of the flow.
", + "CreateContactFlowResponse$ContactFlowId": "The identifier of the flow.
", "CreateTaskTemplateRequest$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", - "DeleteContactFlowRequest$ContactFlowId": "The identifier of the contact flow.
", - "DescribeContactFlowRequest$ContactFlowId": "The identifier of the contact flow.
", + "DeleteContactFlowRequest$ContactFlowId": "The identifier of the flow.
", + "DescribeContactFlowRequest$ContactFlowId": "The identifier of the flow.
", "GetTaskTemplateResponse$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", "OutboundCallerConfig$OutboundFlowId": "The outbound whisper flow to be used during an outbound call.
", - "QueueQuickConnectConfig$ContactFlowId": "The identifier of the contact flow.
", - "StartChatContactRequest$ContactFlowId": "The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", - "StartOutboundVoiceContactRequest$ContactFlowId": "The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", - "StartTaskContactRequest$ContactFlowId": "The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", - "TransferContactRequest$ContactFlowId": "The identifier of the contact flow.
", - "UpdateContactFlowContentRequest$ContactFlowId": "The identifier of the contact flow.
", - "UpdateContactFlowMetadataRequest$ContactFlowId": "The identifier of the contact flow.
", - "UpdateContactFlowNameRequest$ContactFlowId": "The identifier of the contact flow.
", + "QueueQuickConnectConfig$ContactFlowId": "The identifier of the flow.
", + "StartChatContactRequest$ContactFlowId": "The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", + "StartOutboundVoiceContactRequest$ContactFlowId": "The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", + "StartTaskContactRequest$ContactFlowId": "The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
", + "TransferContactRequest$ContactFlowId": "The identifier of the flow.
", + "UpdateContactFlowContentRequest$ContactFlowId": "The identifier of the flow.
", + "UpdateContactFlowMetadataRequest$ContactFlowId": "The identifier of the flow.
", + "UpdateContactFlowNameRequest$ContactFlowId": "The identifier of the flow.
", "UpdateTaskTemplateRequest$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", "UpdateTaskTemplateResponse$ContactFlowId": "The identifier of the flow that runs by default when a task is created by referencing this template.
", - "UserQuickConnectConfig$ContactFlowId": "The identifier of the contact flow.
" + "UserQuickConnectConfig$ContactFlowId": "The identifier of the flow.
" } }, "ContactFlowModule": { - "base": "Contains information about a contact flow module.
", + "base": "Contains information about a flow module.
", "refs": { - "DescribeContactFlowModuleResponse$ContactFlowModule": "Information about the contact flow module.
" + "DescribeContactFlowModuleResponse$ContactFlowModule": "Information about the flow module.
" } }, "ContactFlowModuleContent": { "base": null, "refs": { - "ContactFlowModule$Content": "The content of the contact flow module.
", - "CreateContactFlowModuleRequest$Content": "The content of the contact flow module.
", - "UpdateContactFlowModuleContentRequest$Content": "The content of the contact flow module.
" + "ContactFlowModule$Content": "The content of the flow module.
", + "CreateContactFlowModuleRequest$Content": "The content of the flow module.
", + "UpdateContactFlowModuleContentRequest$Content": "The content of the flow module.
" } }, "ContactFlowModuleDescription": { "base": null, "refs": { - "ContactFlowModule$Description": "The description of the contact flow module.
", - "CreateContactFlowModuleRequest$Description": "The description of the contact flow module.
", - "UpdateContactFlowModuleMetadataRequest$Description": "The description of the contact flow module.
" + "ContactFlowModule$Description": "The description of the flow module.
", + "CreateContactFlowModuleRequest$Description": "The description of the flow module.
", + "UpdateContactFlowModuleMetadataRequest$Description": "The description of the flow module.
" } }, "ContactFlowModuleId": { "base": null, "refs": { - "ContactFlowModule$Id": "The identifier of the contact flow module.
", - "ContactFlowModuleSummary$Id": "The identifier of the contact flow module.
", - "CreateContactFlowModuleResponse$Id": "The identifier of the contact flow module.
", - "DeleteContactFlowModuleRequest$ContactFlowModuleId": "The identifier of the contact flow module.
", - "DescribeContactFlowModuleRequest$ContactFlowModuleId": "The identifier of the contact flow module.
", - "UpdateContactFlowModuleContentRequest$ContactFlowModuleId": "The identifier of the contact flow module.
", - "UpdateContactFlowModuleMetadataRequest$ContactFlowModuleId": "The identifier of the contact flow module.
" + "ContactFlowModule$Id": "The identifier of the flow module.
", + "ContactFlowModuleSummary$Id": "The identifier of the flow module.
", + "CreateContactFlowModuleResponse$Id": "The identifier of the flow module.
", + "DeleteContactFlowModuleRequest$ContactFlowModuleId": "The identifier of the flow module.
", + "DescribeContactFlowModuleRequest$ContactFlowModuleId": "The identifier of the flow module.
", + "UpdateContactFlowModuleContentRequest$ContactFlowModuleId": "The identifier of the flow module.
", + "UpdateContactFlowModuleMetadataRequest$ContactFlowModuleId": "The identifier of the flow module.
" } }, "ContactFlowModuleName": { "base": null, "refs": { - "ContactFlowModule$Name": "The name of the contact flow module.
", - "ContactFlowModuleSummary$Name": "The name of the contact flow module.
", - "CreateContactFlowModuleRequest$Name": "The name of the contact flow module.
", - "UpdateContactFlowModuleMetadataRequest$Name": "The name of the contact flow module.
" + "ContactFlowModule$Name": "The name of the flow module.
", + "ContactFlowModuleSummary$Name": "The name of the flow module.
", + "CreateContactFlowModuleRequest$Name": "The name of the flow module.
", + "UpdateContactFlowModuleMetadataRequest$Name": "The name of the flow module.
" } }, "ContactFlowModuleState": { "base": null, "refs": { - "ContactFlowModule$State": "The type of contact flow module.
", - "ContactFlowModuleSummary$State": "The type of contact flow module.
", - "ListContactFlowModulesRequest$ContactFlowModuleState": "The state of the contact flow module.
", - "UpdateContactFlowModuleMetadataRequest$State": "The state of contact flow module.
" + "ContactFlowModule$State": "The type of flow module.
", + "ContactFlowModuleSummary$State": "The type of flow module.
", + "ListContactFlowModulesRequest$ContactFlowModuleState": "The state of the flow module.
", + "UpdateContactFlowModuleMetadataRequest$State": "The state of flow module.
" } }, "ContactFlowModuleStatus": { "base": null, "refs": { - "ContactFlowModule$Status": "The status of the contact flow module.
" + "ContactFlowModule$Status": "The status of the flow module.
" } }, "ContactFlowModuleSummary": { - "base": "Contains summary information about a contact flow.
", + "base": "Contains summary information about a flow.
", "refs": { "ContactFlowModulesSummaryList$member": null } @@ -801,34 +804,34 @@ "ContactFlowModulesSummaryList": { "base": null, "refs": { - "ListContactFlowModulesResponse$ContactFlowModulesSummaryList": "Information about the contact flow module.
" + "ListContactFlowModulesResponse$ContactFlowModulesSummaryList": "Information about the flow module.
" } }, "ContactFlowName": { "base": null, "refs": { - "ContactFlow$Name": "The name of the contact flow.
", - "ContactFlowSummary$Name": "The name of the contact flow.
", - "CreateContactFlowRequest$Name": "The name of the contact flow.
", - "UpdateContactFlowMetadataRequest$Name": "TThe name of the contact flow.
", - "UpdateContactFlowNameRequest$Name": "The name of the contact flow.
" + "ContactFlow$Name": "The name of the flow.
", + "ContactFlowSummary$Name": "The name of the flow.
", + "CreateContactFlowRequest$Name": "The name of the flow.
", + "UpdateContactFlowMetadataRequest$Name": "TThe name of the flow.
", + "UpdateContactFlowNameRequest$Name": "The name of the flow.
" } }, "ContactFlowNotPublishedException": { - "base": "The contact flow has not been published.
", + "base": "The flow has not been published.
", "refs": { } }, "ContactFlowState": { "base": null, "refs": { - "ContactFlow$State": "The type of contact flow.
", - "ContactFlowSummary$ContactFlowState": "The type of contact flow.
", - "UpdateContactFlowMetadataRequest$ContactFlowState": "The state of contact flow.
" + "ContactFlow$State": "The type of flow.
", + "ContactFlowSummary$ContactFlowState": "The type of flow.
", + "UpdateContactFlowMetadataRequest$ContactFlowState": "The state of flow.
" } }, "ContactFlowSummary": { - "base": "Contains summary information about a contact flow.
You can also create and update contact flows using the Amazon Connect Flow language.
", + "base": "Contains summary information about a flow.
You can also create and update flows using the Amazon Connect Flow language.
", "refs": { "ContactFlowSummaryList$member": null } @@ -836,22 +839,22 @@ "ContactFlowSummaryList": { "base": null, "refs": { - "ListContactFlowsResponse$ContactFlowSummaryList": "Information about the contact flows.
" + "ListContactFlowsResponse$ContactFlowSummaryList": "Information about the flows.
" } }, "ContactFlowType": { "base": null, "refs": { - "ContactFlow$Type": "The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.
", - "ContactFlowSummary$ContactFlowType": "The type of contact flow.
", + "ContactFlow$Type": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
", + "ContactFlowSummary$ContactFlowType": "The type of flow.
", "ContactFlowTypes$member": null, - "CreateContactFlowRequest$Type": "The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.
" + "CreateContactFlowRequest$Type": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
" } }, "ContactFlowTypes": { "base": null, "refs": { - "ListContactFlowsRequest$ContactFlowTypes": "The type of contact flow.
" + "ListContactFlowsRequest$ContactFlowTypes": "The type of flow.
" } }, "ContactId": { @@ -921,6 +924,7 @@ "ControlPlaneTagFilter": { "base": "An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "ResumeContactRecordingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "RoutingProfile$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "SearchSecurityProfilesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SearchUsersRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SearchVocabulariesRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "SecurityProfile$OrganizationResourceId": "The organization resource identifier for the security profile.
", + "SecurityProfileSearchSummary$OrganizationResourceId": "The organization resource identifier.
", "StartChatContactRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "StartContactRecordingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", "StartContactStreamingRequest$InstanceId": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", @@ -2155,7 +2161,7 @@ } }, "InvalidContactFlowException": { - "base": "The contact flow is not valid.
", + "base": "The flow is not valid.
", "refs": { } }, @@ -2601,10 +2607,11 @@ "GetMetricDataRequest$MaxResults": "The maximum number of results to return per page.
", "ListDefaultVocabulariesRequest$MaxResults": "The maximum number of results to return per page.
", "ListIntegrationAssociationsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListQueueQuickConnectsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListRoutingProfileQueuesRequest$MaxResults": "The maximum number of results to return per page.
", + "ListQueueQuickConnectsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListRoutingProfileQueuesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListTaskTemplatesRequest$MaxResults": "The maximum number of results to return per page.
It is not expected that you set this.
The maximum number of results to return per page.
", + "SearchSecurityProfilesRequest$MaxResults": "The maximum number of results to return per page.
", "SearchUsersRequest$MaxResults": "The maximum number of results to return per page.
", "SearchVocabulariesRequest$MaxResults": "The maximum number of results to return per page.
" } @@ -2614,18 +2621,18 @@ "refs": { "ListAgentStatusRequest$MaxResults": "The maximum number of results to return per page.
", "ListContactFlowModulesRequest$MaxResults": "The maximum number of results to return per page.
", - "ListContactFlowsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListHoursOfOperationsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListPhoneNumbersRequest$MaxResults": "The maximum number of results to return per page.
", + "ListContactFlowsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListHoursOfOperationsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListPhoneNumbersRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListPhoneNumbersV2Request$MaxResults": "The maximum number of results to return per page.
", - "ListPromptsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListQueuesRequest$MaxResults": "The maximum number of results to return per page.
", - "ListQuickConnectsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListRoutingProfilesRequest$MaxResults": "The maximum number of results to return per page.
", + "ListPromptsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListQueuesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListQuickConnectsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListRoutingProfilesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", "ListSecurityProfilePermissionsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListSecurityProfilesRequest$MaxResults": "The maximum number of results to return per page.
", - "ListUserHierarchyGroupsRequest$MaxResults": "The maximum number of results to return per page.
", - "ListUsersRequest$MaxResults": "The maximum number of results to return per page.
" + "ListSecurityProfilesRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListUserHierarchyGroupsRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
", + "ListUsersRequest$MaxResults": "The maximum number of results to return per page. The default MaxResult size is 100.
" } }, "MaxResult2": { @@ -2769,6 +2776,8 @@ "NextToken2500": { "base": null, "refs": { + "SearchSecurityProfilesRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "SearchSecurityProfilesResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "SearchUsersRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "SearchUsersResponse$NextToken": "If there are additional results, this is the token for the next set of results.
" } @@ -3010,7 +3019,7 @@ "Problems": { "base": null, "refs": { - "InvalidContactFlowException$problems": "The problems with the contact flow. Please fix before trying again.
", + "InvalidContactFlowException$problems": "The problems with the flow. Please fix before trying again.
", "InvalidContactFlowModuleException$Problems": null } }, @@ -3039,7 +3048,7 @@ } }, "PropertyValidationException": { - "base": "", + "base": "The property is not valid.
", "refs": { } }, @@ -3103,7 +3112,7 @@ "RoutingProfile$DefaultOutboundQueueId": "The identifier of the default outbound queue for this routing profile.
", "RoutingProfileQueueConfigSummary$QueueId": "The identifier for the queue.
", "RoutingProfileQueueReference$QueueId": "The identifier for the queue.
", - "StartOutboundVoiceContactRequest$QueueId": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
", + "StartOutboundVoiceContactRequest$QueueId": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
", "TransferContactRequest$QueueId": "The identifier for the queue.
", "UpdateQueueHoursOfOperationRequest$QueueId": "The identifier for the queue.
", "UpdateQueueMaxContactsRequest$QueueId": "The identifier for the queue.
", @@ -3135,7 +3144,7 @@ } }, "QueueQuickConnectConfig": { - "base": "Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.
", + "base": "Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.
", "refs": { "QuickConnectConfig$QueueConfig": "The queue configuration. This is required only if QuickConnectType is QUEUE.
" } @@ -3310,7 +3319,7 @@ "ReferenceSummaryList": { "base": null, "refs": { - "ListContactReferencesResponse$ReferenceSummaryList": "Information about the contact flows.
" + "ListContactReferencesResponse$ReferenceSummaryList": "Information about the flows.
" } }, "ReferenceType": { @@ -3503,6 +3512,16 @@ "refs": { } }, + "SearchSecurityProfilesRequest": { + "base": null, + "refs": { + } + }, + "SearchSecurityProfilesResponse": { + "base": null, + "refs": { + } + }, "SearchUsersRequest": { "base": null, "refs": { @@ -3546,6 +3565,7 @@ "refs": { "CreateSecurityProfileRequest$Description": "The description of the security profile.
", "SecurityProfile$Description": "The description of the security profile.
", + "SecurityProfileSearchSummary$Description": "The description of the security profile.
", "UpdateSecurityProfileRequest$Description": "The description of the security profile.
" } }, @@ -3558,6 +3578,7 @@ "ListSecurityProfilePermissionsRequest$SecurityProfileId": "The identifier for the security profle.
", "SecurityProfile$Id": "The identifier for the security profile.
", "SecurityProfileIds$member": null, + "SecurityProfileSearchSummary$Id": "The identifier of the security profile.
", "SecurityProfileSummary$Id": "The identifier of the security profile.
", "UpdateSecurityProfileRequest$SecurityProfileId": "The identifier for the security profle.
" } @@ -3576,6 +3597,7 @@ "refs": { "CreateSecurityProfileRequest$SecurityProfileName": "The name of the security profile.
", "SecurityProfile$SecurityProfileName": "The name for the security profile.
", + "SecurityProfileSearchSummary$SecurityProfileName": "The name of the security profile.
", "SecurityProfileSummary$Name": "The name of the security profile.
" } }, @@ -3585,6 +3607,26 @@ "PermissionsList$member": null } }, + "SecurityProfileSearchConditionList": { + "base": null, + "refs": { + "SecurityProfileSearchCriteria$OrConditions": "A list of conditions which would be applied together with an OR condition.
", + "SecurityProfileSearchCriteria$AndConditions": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "SecurityProfileSearchCriteria": { + "base": "The search criteria to be used to return security profiles.
", + "refs": { + "SearchSecurityProfilesRequest$SearchCriteria": "The search criteria to be used to return security profiles.
", + "SecurityProfileSearchConditionList$member": null + } + }, + "SecurityProfileSearchSummary": { + "base": "Information about the returned security profiles.
", + "refs": { + "SecurityProfilesSearchSummaryList$member": null + } + }, "SecurityProfileSummary": { "base": "Contains information about a security profile.
", "refs": { @@ -3597,6 +3639,18 @@ "ListSecurityProfilesResponse$SecurityProfileSummaryList": "Information about the security profiles.
" } }, + "SecurityProfilesSearchFilter": { + "base": "Filters to be applied to search results.
", + "refs": { + "SearchSecurityProfilesRequest$SearchFilter": "Filters to be applied to search results.
" + } + }, + "SecurityProfilesSearchSummaryList": { + "base": null, + "refs": { + "SearchSecurityProfilesResponse$SecurityProfiles": "Information about the security profiles.
" + } + }, "SecurityToken": { "base": null, "refs": { @@ -3755,6 +3809,7 @@ "StringCondition": { "base": "A leaf node condition which can be used to specify a string condition, for example, username = 'abc'.
A leaf node condition which can be used to specify a string condition.
" } }, @@ -3816,36 +3871,37 @@ "TagMap": { "base": null, "refs": { - "AgentStatus$Tags": "The tags used to organize, track, or control access for this resource.
", - "ClaimPhoneNumberRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "ClaimedPhoneNumberSummary$Tags": "The tags used to organize, track, or control access for this resource.
", - "ContactFlow$Tags": "One or more tags.
", - "ContactFlowModule$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateAgentStatusRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateContactFlowModuleRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateContactFlowRequest$Tags": "One or more tags.
", - "CreateHoursOfOperationRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateIntegrationAssociationRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateQueueRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateQuickConnectRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateRoutingProfileRequest$Tags": "One or more tags.
", - "CreateSecurityProfileRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateUseCaseRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateUserHierarchyGroupRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "CreateUserRequest$Tags": "One or more tags.
", - "CreateVocabularyRequest$Tags": "The tags used to organize, track, or control access for this resource.
", - "GetTaskTemplateResponse$Tags": "The tags used to organize, track, or control access for this resource.
", - "HierarchyGroup$Tags": "The tags used to organize, track, or control access for this resource.
", - "HoursOfOperation$Tags": "The tags used to organize, track, or control access for this resource.
", + "AgentStatus$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "ClaimPhoneNumberRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "ClaimedPhoneNumberSummary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "ContactFlow$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "ContactFlowModule$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateAgentStatusRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateContactFlowModuleRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateContactFlowRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateHoursOfOperationRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateIntegrationAssociationRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateQueueRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateQuickConnectRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateRoutingProfileRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateSecurityProfileRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateUseCaseRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateUserHierarchyGroupRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateUserRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "CreateVocabularyRequest$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "GetTaskTemplateResponse$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "HierarchyGroup$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "HoursOfOperation$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "ListTagsForResourceResponse$tags": "Information about the tags.
", - "Queue$Tags": "The tags used to organize, track, or control access for this resource.
", - "QuickConnect$Tags": "The tags used to organize, track, or control access for this resource.
", - "RoutingProfile$Tags": "One or more tags.
", - "SecurityProfile$Tags": "The tags used to organize, track, or control access for this resource.
", - "TagResourceRequest$tags": "One or more tags. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "Queue$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "QuickConnect$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "RoutingProfile$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "SecurityProfile$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "SecurityProfileSearchSummary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "TagResourceRequest$tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "User$Tags": "The tags.
", - "UserSearchSummary$Tags": "The tags used to organize, track, or control access for this resource.
", - "Vocabulary$Tags": "The tags used to organize, track, or control access for this resource.
" + "UserSearchSummary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "Vocabulary$Tags": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "TagOrConditionList": { @@ -4049,8 +4105,8 @@ "AgentStatusReference$StatusStartTimestamp": "The start timestamp of the agent's status.
", "Instance$CreatedTime": "When the instance was created.
", "InstanceSummary$CreatedTime": "When the instance was created.
", - "StartTaskContactRequest$ScheduledTime": "The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
", - "UpdateContactScheduleRequest$ScheduledTime": "The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
" + "StartTaskContactRequest$ScheduledTime": "The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
", + "UpdateContactScheduleRequest$ScheduledTime": "The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
" } }, "TrafficType": { diff --git a/models/apis/connect/2017-08-08/paginators-1.json b/models/apis/connect/2017-08-08/paginators-1.json index f4032d522c..fd8db0abd2 100644 --- a/models/apis/connect/2017-08-08/paginators-1.json +++ b/models/apis/connect/2017-08-08/paginators-1.json @@ -194,6 +194,15 @@ "output_token": "NextToken", "result_key": "AvailableNumbersList" }, + "SearchSecurityProfiles": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "non_aggregate_keys": [ + "ApproximateTotalCount" + ], + "output_token": "NextToken", + "result_key": "SecurityProfiles" + }, "SearchUsers": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/ivschat/2020-07-14/docs-2.json b/models/apis/ivschat/2020-07-14/docs-2.json index 5843e1b08d..b14b392951 100644 --- a/models/apis/ivschat/2020-07-14/docs-2.json +++ b/models/apis/ivschat/2020-07-14/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resource is part of Amazon IVS Chat:
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Messaging Endpoints
DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Chat Token Endpoint
CreateChatToken — Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.
Room Endpoints
CreateRoom — Creates a room that allows clients to connect and pass messages.
DeleteRoom — Deletes the specified room.
GetRoom — Gets the specified room.
ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.
UpdateRoom — Updates a room’s configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
", + "service": "Introduction
The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat resources. You also need to integrate with the Amazon IVS Chat Messaging API, to enable users to interact with chat rooms in real time.
The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the AWS General Reference.
Notes on terminology:
You create service applications using the Amazon IVS Chat API. We refer to these as applications.
You create front-end client applications (browser and Android/iOS apps) using the Amazon IVS Chat Messaging API. We refer to these as clients.
Resources
The following resource is part of Amazon IVS Chat:
Room — The central Amazon IVS Chat resource through which clients connect to and exchange chat messages. See the Room endpoints for more information.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Room.
At most 50 tags can be applied to a resource.
API Access Security
Your Amazon IVS Chat applications (service applications and clients) must be authenticated and authorized to access Amazon IVS Chat resources. Note the differences between these concepts:
Authentication is about verifying identity. Requests to the Amazon IVS Chat API must be signed to verify your identity.
Authorization is about granting permissions. Your IAM roles need to have permissions for Amazon IVS Chat API requests.
Users (viewers) connect to a room using secure access tokens that you create using the CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for every user’s chat session, passing identity and authorization information about the user.
Signing API Requests
HTTP API requests must be signed with an AWS SigV4 signature using your AWS security credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API directly, it’s your responsibility to sign the requests.
You generate a signature using valid AWS credentials for an IAM role that has permission to perform the requested action. For example, DeleteMessage requests must be made using an IAM role that has the ivschat:DeleteMessage permission.
For more information:
Authentication and generating signatures — See Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon Web Services General Reference.
Managing Amazon IVS permissions — See Identity and Access Management on the Security page of the Amazon IVS User Guide.
Messaging Endpoints
DeleteMessage — Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.
DisconnectUser — Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
SendEvent — Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Chat Token Endpoint
CreateChatToken — Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.
Room Endpoints
CreateRoom — Creates a room that allows clients to connect and pass messages.
DeleteRoom — Deletes the specified room.
GetRoom — Gets the specified room.
ListRooms — Gets summary information about all your rooms in the AWS region where the API request is processed.
UpdateRoom — Updates a room’s configuration.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
All the above are HTTP operations. There is a separate messaging API for managing Chat resources; see the Amazon IVS Chat Messaging API Reference.
", "operations": { "CreateChatToken": "Creates an encrypted token that is used to establish an individual WebSocket connection to a room. The token is valid for one minute, and a connection (session) established with the token is valid for the specified duration.
Encryption keys are owned by Amazon IVS Chat and never used directly by your application.
", "CreateRoom": "Creates a room that allows clients to connect and pass messages.
", @@ -376,7 +376,7 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceRequest$tagKeys": "Array of tags to be removed.
" + "UntagResourceRequest$tagKeys": "Array of tags to be removed. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
" } }, "TagResourceRequest": { @@ -398,12 +398,12 @@ "Tags": { "base": null, "refs": { - "CreateRoomRequest$tags": "Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
Tags attached to the resource, from the request.
", "GetRoomResponse$tags": "Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags to attach to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource.
", - "TagResourceRequest$tags": "Array of tags to be added or updated.
", + "ListTagsForResourceResponse$tags": "Tags attached to the resource, from the request.
", + "RoomSummary$tags": "Tags attached to the resource. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
", + "TagResourceRequest$tags": "Array of tags to be added or updated. See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS Chat has no constraints beyond what is documented there.
", "UpdateRoomResponse$tags": "Tags attached to the resource.
" } }, diff --git a/models/apis/kendra/2019-02-03/api-2.json b/models/apis/kendra/2019-02-03/api-2.json index 4be223264e..35c7abee65 100644 --- a/models/apis/kendra/2019-02-03/api-2.json +++ b/models/apis/kendra/2019-02-03/api-2.json @@ -2582,6 +2582,13 @@ }, "type": "structure" }, + "ConfluenceAuthenticationType": { + "enum": [ + "HTTP_BASIC", + "PAT" + ], + "type": "string" + }, "ConfluenceBlogConfiguration": { "members": { "BlogFieldMappings": { @@ -2631,6 +2638,9 @@ "AttachmentConfiguration": { "shape": "ConfluenceAttachmentConfiguration" }, + "AuthenticationType": { + "shape": "ConfluenceAuthenticationType" + }, "BlogConfiguration": { "shape": "ConfluenceBlogConfiguration" }, diff --git a/models/apis/kendra/2019-02-03/docs-2.json b/models/apis/kendra/2019-02-03/docs-2.json index 81222fd823..d23fdce019 100644 --- a/models/apis/kendra/2019-02-03/docs-2.json +++ b/models/apis/kendra/2019-02-03/docs-2.json @@ -9,14 +9,14 @@ "BatchPutDocument": "Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
", "ClearQuerySuggestions": "Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
ClearQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
Creates a data source that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
", + "CreateDataSource": "Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Amazon S3 and custom data sources are the only supported data sources in the Amazon Web Services GovCloud (US-West) region.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
", "CreateExperience": "Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
", "CreateFaq": "Creates an new set of frequently asked question (FAQ) questions and answers.
Adding FAQs to an index is an asynchronous operation.
For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
", "CreateIndex": "Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the BatchPutDocument API or using one of the supported data sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
", "CreateQuerySuggestionsBlockList": "Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
", "CreateThesaurus": "Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
", "DeleteAccessControlConfiguration": "Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", - "DeleteDataSource": "Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources.
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "DeleteFaq": "Removes an FAQ from an index.
", "DeleteIndex": "Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex API is set to DELETING.
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
DeleteQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Deletes an existing Amazon Kendra thesaurus.
", "DescribeAccessControlConfiguration": "Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", - "DescribeDataSource": "Gets information about an Amazon Kendra data source.
", + "DescribeDataSource": "Gets information about an Amazon Kendra data source connector.
", "DescribeExperience": "Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "DescribeFaq": "Gets information about an FAQ list.
", "DescribeIndex": "Gets information about an existing Amazon Kendra index.
", @@ -37,8 +37,8 @@ "GetQuerySuggestions": "Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
", "ListAccessControlConfigurations": "Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
", - "ListDataSourceSyncJobs": "Gets statistics about synchronizing Amazon Kendra with a data source.
", - "ListDataSources": "Lists the data sources that you have created.
", + "ListDataSourceSyncJobs": "Gets statistics about synchronizing a data source connector.
", + "ListDataSources": "Lists the data source connectors that you have created.
", "ListEntityPersonas": "Lists specific permissions of users and groups with access to your Amazon Kendra experience.
", "ListExperienceEntities": "Lists users or groups in your Amazon Web Services SSO identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "ListExperiences": "Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", @@ -50,13 +50,13 @@ "ListThesauri": "Lists the thesauri for an index.
", "PutPrincipalMapping": "Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.
If more than five PUT actions for a group are currently processing, a validation exception is thrown.
PutPrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Searches an active index. Use this API to search your documents using query. The Query API enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.
Each query returns the 100 most relevant results.
", - "StartDataSourceSyncJob": "Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
", "SubmitFeedback": "Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.
", "UntagResource": "Removes a tag from an index, FAQ, or a data source.
", "UpdateAccessControlConfiguration": "Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.
Updates an existing Amazon Kendra data source.
", + "UpdateDataSource": "Updates an existing Amazon Kendra data source connector.
", "UpdateExperience": "Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
", "UpdateIndex": "Updates an existing Amazon Kendra index.
", "UpdateQuerySuggestionsBlockList": "Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
UpdateQuerySuggestionsBlockList is currently not supported in the Amazon Web Services GovCloud (US-West) region.
Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.
" + } + }, "ConfluenceBlogConfiguration": { "base": "Configuration of blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the ConfluenceConfiguration object.
Provides the configuration information for an Amazon Kendra data source.
", "refs": { "CreateDataSourceRequest$Configuration": "Configuration information to connect to your data source repository.
You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
The Configuration parameter is required for all other data sources.
Configuration details for the data source. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
", + "DescribeDataSourceResponse$Configuration": "Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
", "UpdateDataSourceRequest$Configuration": "Configuration information you want to update for the data source connector.
" } }, @@ -715,20 +721,20 @@ "DataSourceIdList$member": null, "DataSourceSummary$Id": "The unique identifier for the data source.
", "DataSourceSyncJobMetricTarget$DataSourceId": "The ID of the data source that is running the sync job.
", - "DeleteDataSourceRequest$Id": "The identifier of the data source you want to delete.
", + "DeleteDataSourceRequest$Id": "The identifier of the data source connector you want to delete.
", "DeletePrincipalMappingRequest$DataSourceId": "The identifier of the data source you want to delete a group from.
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only \"Sales and Marketing\" should access documents in the Salesforce data source.
", - "DescribeDataSourceRequest$Id": "The identifier of the data source.
", - "DescribeDataSourceResponse$Id": "The identifier of the data source.
", + "DescribeDataSourceRequest$Id": "The identifier of the data source connector.
", + "DescribeDataSourceResponse$Id": "The identifier of the data source connector.
", "DescribePrincipalMappingRequest$DataSourceId": "The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.
Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.
The identifier of the data source.
", + "ListDataSourceSyncJobsRequest$Id": "The identifier of the data source connector.
", "ListGroupsOlderThanOrderingIdRequest$DataSourceId": "The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
", "MemberGroup$DataSourceId": "The identifier of the data source for the sub group you want to map to a group.
", "Principal$DataSourceId": "The identifier of the data source the principal should access documents from.
", "PutPrincipalMappingRequest$DataSourceId": "The identifier of the data source you want to map users to their groups.
This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, \"Sales and Marketing\" team only needs access to customer-related documents stored in Salesforce.
", - "StartDataSourceSyncJobRequest$Id": "The identifier of the data source to synchronize.
", - "StopDataSourceSyncJobRequest$Id": "The identifier of the data source for which to stop the synchronization jobs.
", - "UpdateDataSourceRequest$Id": "The identifier of the data source you want to update.
" + "StartDataSourceSyncJobRequest$Id": "The identifier of the data source connector to synchronize.
", + "StopDataSourceSyncJobRequest$Id": "The identifier of the data source connector for which to stop the synchronization jobs.
", + "UpdateDataSourceRequest$Id": "The identifier of the data source connector you want to update.
" } }, "DataSourceIdList": { @@ -786,7 +792,7 @@ "refs": { "CreateDataSourceRequest$Name": "A name for the data source connector.
", "DataSourceSummary$Name": "The name of the data source.
", - "DescribeDataSourceResponse$Name": "The name for the data source.
", + "DescribeDataSourceResponse$Name": "The name for the data source connector.
", "UpdateDataSourceRequest$Name": "A new name for the data source connector.
" } }, @@ -794,7 +800,7 @@ "base": null, "refs": { "DataSourceSummary$Status": "The status of the data source. When the status is ACTIVE the data source is ready to use.
The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
An array of summary information for one or more data sources.
" + "ListDataSourcesResponse$SummaryItems": "An array of summary information for one or more data source connector.
" } }, "DataSourceSyncJob": { @@ -818,7 +824,7 @@ "DataSourceSyncJobHistoryList": { "base": null, "refs": { - "ListDataSourceSyncJobsResponse$History": "A history of synchronization jobs for the data source.
" + "ListDataSourceSyncJobsResponse$History": "A history of synchronization jobs for the data source connector.
" } }, "DataSourceSyncJobId": { @@ -843,7 +849,7 @@ "base": null, "refs": { "DataSourceSyncJob$Status": "The execution status of the synchronization job. When the Status field is set to SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the ErrorCode and ErrorMessage fields give you the reason for the failure.
When specified, only returns synchronization jobs with the Status field equal to the specified status.
Only returns synchronization jobs with the Status field equal to the specified status.
The type of data source repository. For example, SHAREPOINT.
The type of the data source.
", - "DescribeDataSourceResponse$Type": "The type of the data source.
" + "DescribeDataSourceResponse$Type": "The type of the data source. For example, SHAREPOINT.
A user-friendly description for the block list.
For example, the description \"List of all offensive words that can appear in user queries and need to be blocked from suggestions.\"
", "CreateThesaurusRequest$Description": "A description for the thesaurus.
", "DescribeAccessControlConfigurationResponse$Description": "The description for the access control configuration.
", - "DescribeDataSourceResponse$Description": "The description for the data source.
", + "DescribeDataSourceResponse$Description": "The description for the data source connector.
", "DescribeExperienceResponse$Description": "Shows the description for your Amazon Kendra experience.
", "DescribeFaqResponse$Description": "The description of the FAQ that you provided when it was created.
", "DescribeIndexResponse$Description": "The description for the index.
", @@ -1335,7 +1341,7 @@ "Domain": { "base": null, "refs": { - "QuipConfiguration$Domain": "The Quip site domain.
" + "QuipConfiguration$Domain": "The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is \"quipdomain\".
" } }, "Duration": { @@ -1676,7 +1682,7 @@ "FolderIdList": { "base": null, "refs": { - "QuipConfiguration$FolderIds": "The identifiers of the Quip folders you want to index. You can find in your browser URL when you access your folder in Quip. For example, https://quip-company.com/zlLuOVNSarTL/folder-name.
" + "QuipConfiguration$FolderIds": "The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is \"zlLuOVNSarTL\".
" } }, "FsxConfiguration": { @@ -1883,7 +1889,7 @@ "CreateQuerySuggestionsBlockListRequest$IndexId": "The identifier of the index you want to create a query suggestions block list for.
", "CreateThesaurusRequest$IndexId": "The identifier of the index for the thesaurus.
", "DeleteAccessControlConfigurationRequest$IndexId": "The identifier of the index for an access control configuration.
", - "DeleteDataSourceRequest$IndexId": "The identifier of the index used with the data source.
", + "DeleteDataSourceRequest$IndexId": "The identifier of the index used with the data source connector.
", "DeleteExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "DeleteFaqRequest$IndexId": "The identifier of the index for the FAQ.
", "DeleteIndexRequest$Id": "The identifier of the index you want to delete.
", @@ -1891,8 +1897,8 @@ "DeleteQuerySuggestionsBlockListRequest$IndexId": "The identifier of the index for the block list.
", "DeleteThesaurusRequest$IndexId": "The identifier of the index for the thesaurus.
", "DescribeAccessControlConfigurationRequest$IndexId": "The identifier of the index for an access control configuration.
", - "DescribeDataSourceRequest$IndexId": "The identifier of the index used with the data source.
", - "DescribeDataSourceResponse$IndexId": "The identifier of the index that contains the data source.
", + "DescribeDataSourceRequest$IndexId": "The identifier of the index used with the data source connector.
", + "DescribeDataSourceResponse$IndexId": "The identifier of the index used with the data source connector.
", "DescribeExperienceRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "DescribeExperienceResponse$IndexId": "Shows the identifier of the index for your Amazon Kendra experience.
", "DescribeFaqRequest$IndexId": "The identifier of the index for the FAQ.
", @@ -1912,8 +1918,8 @@ "GetSnapshotsRequest$IndexId": "The identifier of the index to get search metrics data.
", "IndexConfigurationSummary$Id": "A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
The identifier of the index for the access control configuration.
", - "ListDataSourceSyncJobsRequest$IndexId": "The identifier of the index used with the data source.
", - "ListDataSourcesRequest$IndexId": "The identifier of the index used with one or more data sources.
", + "ListDataSourceSyncJobsRequest$IndexId": "The identifier of the index used with the data source connector.
", + "ListDataSourcesRequest$IndexId": "The identifier of the index used with one or more data source connectors.
", "ListEntityPersonasRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "ListExperienceEntitiesRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", "ListExperiencesRequest$IndexId": "The identifier of the index for your Amazon Kendra experience.
", @@ -1923,8 +1929,8 @@ "ListThesauriRequest$IndexId": "The identifier of the index with one or more thesauri.
", "PutPrincipalMappingRequest$IndexId": "The identifier of the index you want to map users to their groups.
", "QueryRequest$IndexId": "The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex API.
The identifier of the index that contains the data source.
", - "StopDataSourceSyncJobRequest$IndexId": "The identifier of the index that contains the data source.
", + "StartDataSourceSyncJobRequest$IndexId": "The identifier of the index used with the data source connector.
", + "StopDataSourceSyncJobRequest$IndexId": "The identifier of the index used with the data source connector.
", "SubmitFeedbackRequest$IndexId": "The identifier of the index that was queried.
", "UpdateAccessControlConfigurationRequest$IndexId": "The identifier of the index for an access control configuration.
", "UpdateDataSourceRequest$IndexId": "The identifier of the index used with the data source connector.
", @@ -2278,7 +2284,7 @@ "MaxResultsIntegerForListDataSourcesRequest": { "base": null, "refs": { - "ListDataSourcesRequest$MaxResults": "The maximum number of data sources to return.
" + "ListDataSourcesRequest$MaxResults": "The maximum number of data source connectors to return.
" } }, "MaxResultsIntegerForListEntityPersonasRequest": { @@ -2413,8 +2419,8 @@ "GetSnapshotsResponse$NextToken": "If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.
", "ListDataSourceSyncJobsRequest$NextToken": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of jobs.
", "ListDataSourceSyncJobsResponse$NextToken": "If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of jobs.
", - "ListDataSourcesRequest$NextToken": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data sources (DataSourceSummaryItems).
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data sources.
", + "ListDataSourcesRequest$NextToken": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data source connectors (DataSourceSummaryItems).
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data source connectors.
", "ListEntityPersonasRequest$NextToken": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.
", "ListEntityPersonasResponse$NextToken": "If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.
", "ListExperienceEntitiesRequest$NextToken": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.
", @@ -2780,14 +2786,14 @@ "base": null, "refs": { "BatchPutDocumentRequest$RoleArn": "The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument API. For more information, see IAM Roles for Amazon Kendra.
The Amazon Resource Name (ARN) of a role with permission to access the data source connector. For more information, see IAM Roles for Amazon Kendra.
You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
The RoleArn parameter is required for all other data sources.
The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.
You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
The RoleArn parameter is required for all other data sources.
The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
", "CreateIndexRequest$RoleArn": "An Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role you use when you call the BatchPutDocument API to index documents from an Amazon S3 bucket.
The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.
You need permissions to the role ARN (Amazon Web Services Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.
", "CreateThesaurusRequest$RoleArn": "An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see IAM roles for Amazon Kendra.
The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
", + "DescribeDataSourceResponse$RoleArn": "The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
", "DescribeExperienceResponse$RoleArn": "Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
", "DescribeIndexResponse$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
", @@ -2795,7 +2801,7 @@ "DescribeThesaurusResponse$RoleArn": "An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.
The Amazon Resource Name (arn) of the secret.
", "PutPrincipalMappingRequest$RoleArn": "The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.
For more information, see IAM roles for Amazon Kendra.
", - "UpdateDataSourceRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.
", + "UpdateDataSourceRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra.
", "UpdateExperienceRequest$RoleArn": "The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information. For more information, see IAM roles for Amazon Kendra.
An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
", "UpdateQuerySuggestionsBlockListRequest$RoleArn": "The IAM (Identity and Access Management) role used to access the block list text file in S3.
", @@ -2827,7 +2833,7 @@ "S3Path": { "base": "Information required to find a specific file in an Amazon S3 bucket.
", "refs": { - "AlfrescoConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco.
", + "AlfrescoConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
", "CreateFaqRequest$S3Path": "The path to the FAQ file in S3.
", "CreateQuerySuggestionsBlockListRequest$SourceS3Path": "The S3 path to your block list text file in your S3 bucket.
Each block word or phrase should be on a separate line in a text file.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
", "CreateThesaurusRequest$SourceS3Path": "The path to the thesaurus file in S3.
", @@ -2836,9 +2842,9 @@ "DescribeThesaurusResponse$SourceS3Path": null, "Document$S3Path": null, "GroupMembers$S3PathforGroupMembers": "If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.
The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub.
", + "OnPremiseConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to GitHub if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
", "OneDriveUsers$OneDriveUserS3Path": "The S3 bucket location of a file containing a list of users whose documents should be indexed.
", - "SharePointConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint.
", + "SharePointConfiguration$SslCertificateS3Path": "The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.
You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see Create and sign an X509 certificate.
", "UpdateQuerySuggestionsBlockListRequest$SourceS3Path": "The S3 path where your block list text file sits in S3.
If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.
If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.
", "UpdateThesaurusRequest$SourceS3Path": null } @@ -2971,7 +2977,7 @@ "AlfrescoConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:
username—The user name of the Alfresco account.
password—The password of the Alfresco account.
Your secret ARN, which you can create in Secrets Manager
You use a secret if basic authentication credentials are required to connect to a website. The secret stores your credentials of user name and password.
", "BoxConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Box platform. The secret must contain a JSON structure with the following keys:
clientID—The identifier of the client OAuth 2.0 authentication application created in Box.
clientSecret—A set of characters known only to the OAuth 2.0 authentication application created in Box.
publicKeyId—The identifier of the public key contained within an identity certificate.
privateKey—A set of characters that make up an encryption key.
passphrase—A set of characters that act like a password.
You create an application in Box to generate the keys or credentials required for the secret. For more information, see Authentication for a Box data source.
", - "ConfluenceConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.
", + "ConfluenceConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password. For more information, see Using a Confluence data source.
You can also provide authentication credentials in the form of a personal access token. For more information, see Authentication for a Confluence data source.
", "ConnectionConfiguration$SecretArn": "The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.
", "FsxConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Amazon FSx file system. Windows is currently the only supported type. The secret must contain a JSON structure with the following keys:
username—The Active Directory user name, along with the Domain Name System (DNS) domain name. For example, user@corp.example.com. The Active Directory user account must have read and mounting access to the Amazon FSx file system for Windows.
password—The password of the Active Directory user account with read and mounting access to the Amazon FSx Windows file system.
The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your GitHub. The secret must contain a JSON structure with the following keys:
githubToken—The access token created in GitHub. For more information on creating a token in GitHub, see Authentication for a GitHub data source.
The Microsoft SharePoint site URLs for the documents you want to indext.
" + "SharePointConfiguration$Urls": "The Microsoft SharePoint site URLs for the documents you want to index.
" } }, "SharePointVersion": { @@ -3472,7 +3478,7 @@ "base": "Provides a range of time.
", "refs": { "GetSnapshotsResponse$SnapShotTimeFilter": "The date-time for the beginning and end of the time window for the search metrics data.
", - "ListDataSourceSyncJobsRequest$StartTimeFilter": "When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
" + "ListDataSourceSyncJobsRequest$StartTimeFilter": "When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
" } }, "Timestamp": { @@ -3483,8 +3489,8 @@ "DataSourceSummary$UpdatedAt": "The UNIX datetime that the data source was lasted updated.
", "DataSourceSyncJob$StartTime": "The UNIX datetime that the synchronization job started.
", "DataSourceSyncJob$EndTime": "The UNIX datetime that the synchronization job completed.
", - "DescribeDataSourceResponse$CreatedAt": "The Unix timestamp of when the data source was created.
", - "DescribeDataSourceResponse$UpdatedAt": "The Unix timestamp of when the data source was last updated.
", + "DescribeDataSourceResponse$CreatedAt": "The Unix timestamp of when the data source connector was created.
", + "DescribeDataSourceResponse$UpdatedAt": "The Unix timestamp of when the data source connector was last updated.
", "DescribeExperienceResponse$CreatedAt": "Shows the date-time your Amazon Kendra experience was created.
", "DescribeExperienceResponse$UpdatedAt": "Shows the date-time your Amazon Kendra experience was last updated.
", "DescribeFaqResponse$CreatedAt": "The date and time that the FAQ was created.
", diff --git a/models/apis/lookoutmetrics/2017-07-25/api-2.json b/models/apis/lookoutmetrics/2017-07-25/api-2.json index 590043d809..5bdfffa1d9 100644 --- a/models/apis/lookoutmetrics/2017-07-25/api-2.json +++ b/models/apis/lookoutmetrics/2017-07-25/api-2.json @@ -246,6 +246,22 @@ {"shape":"TooManyRequestsException"} ] }, + "GetDataQualityMetrics":{ + "name":"GetDataQualityMetrics", + "http":{ + "method":"POST", + "requestUri":"/GetDataQualityMetrics" + }, + "input":{"shape":"GetDataQualityMetricsRequest"}, + "output":{"shape":"GetDataQualityMetricsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ] + }, "GetFeedback":{ "name":"GetFeedback", "http":{ @@ -615,6 +631,17 @@ "AnomalyDetectorFrequency":{"shape":"Frequency"} } }, + "AnomalyDetectorDataQualityMetric":{ + "type":"structure", + "members":{ + "StartTimestamp":{"shape":"Timestamp"}, + "MetricSetDataQualityMetricList":{"shape":"MetricSetDataQualityMetricList"} + } + }, + "AnomalyDetectorDataQualityMetricList":{ + "type":"list", + "member":{"shape":"AnomalyDetectorDataQualityMetric"} + }, "AnomalyDetectorDescription":{ "type":"string", "max":256, @@ -960,6 +987,40 @@ } }, "DataItem":{"type":"string"}, + "DataQualityMetric":{ + "type":"structure", + "members":{ + "MetricType":{"shape":"DataQualityMetricType"}, + "MetricDescription":{"shape":"DataQualityMetricDescription"}, + "RelatedColumnName":{"shape":"RelatedColumnName"}, + "MetricValue":{"shape":"Double"} + } + }, + "DataQualityMetricDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, + "DataQualityMetricList":{ + "type":"list", + "member":{"shape":"DataQualityMetric"} + }, + "DataQualityMetricType":{ + "type":"string", + "enum":[ + "COLUMN_COMPLETENESS", + "DIMENSION_UNIQUENESS", + "TIME_SERIES_COUNT", + "ROWS_PROCESSED", + "ROWS_PARTIAL_COMPLIANCE", + "INVALID_ROWS_COMPLIANCE", + "BACKTEST_TRAINING_DATA_START_TIME_STAMP", + "BACKTEST_TRAINING_DATA_END_TIME_STAMP", + "BACKTEST_INFERENCE_DATA_START_TIME_STAMP", + "BACKTEST_INFERENCE_DATA_END_TIME_STAMP" + ] + }, "DatabaseHost":{ "type":"string", "max":253, @@ -1232,6 +1293,7 @@ "max":10, "min":1 }, + "Double":{"type":"double"}, "ErrorMessage":{ "type":"string", "max":256 @@ -1287,6 +1349,20 @@ "AnomalyGroup":{"shape":"AnomalyGroup"} } }, + "GetDataQualityMetricsRequest":{ + "type":"structure", + "required":["AnomalyDetectorArn"], + "members":{ + "AnomalyDetectorArn":{"shape":"Arn"}, + "MetricSetArn":{"shape":"Arn"} + } + }, + "GetDataQualityMetricsResponse":{ + "type":"structure", + "members":{ + "AnomalyDetectorDataQualityMetricList":{"shape":"AnomalyDetectorDataQualityMetricList"} + } + }, "GetFeedbackRequest":{ "type":"structure", "required":[ @@ -1609,6 +1685,17 @@ "max":5, "min":1 }, + "MetricSetDataQualityMetric":{ + "type":"structure", + "members":{ + "MetricSetArn":{"shape":"Arn"}, + "DataQualityMetricList":{"shape":"DataQualityMetricList"} + } + }, + "MetricSetDataQualityMetricList":{ + "type":"list", + "member":{"shape":"MetricSetDataQualityMetric"} + }, "MetricSetDescription":{ "type":"string", "max":256, @@ -1758,6 +1845,12 @@ "VpcConfiguration":{"shape":"VpcConfiguration"} } }, + "RelatedColumnName":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, "RelationshipType":{ "type":"string", "enum":[ diff --git a/models/apis/lookoutmetrics/2017-07-25/docs-2.json b/models/apis/lookoutmetrics/2017-07-25/docs-2.json index 47669f9a2e..df88efbffc 100644 --- a/models/apis/lookoutmetrics/2017-07-25/docs-2.json +++ b/models/apis/lookoutmetrics/2017-07-25/docs-2.json @@ -16,6 +16,7 @@ "DescribeMetricSet": "Describes a dataset.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
", "DetectMetricSetConfig": "Detects an Amazon S3 dataset's file format, interval, and offset.
", "GetAnomalyGroup": "Returns details about a group of anomalous metrics.
", + "GetDataQualityMetrics": "Returns details about the requested data quality metrics.
", "GetFeedback": "Get feedback for an anomaly group.
", "GetSampleData": "Returns a selection of sample records from an Amazon S3 datasource.
", "ListAlerts": "Lists the alerts attached to a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
", @@ -143,6 +144,18 @@ "DescribeAnomalyDetectorResponse$AnomalyDetectorConfig": "Contains information about the detector's configuration.
" } }, + "AnomalyDetectorDataQualityMetric": { + "base": "Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.
A list of the data quality metrics for the AnomalyDetectorArn that you requested.
The ARN of the detector that contains the dataset.
", "DetectMetricSetConfigRequest$AnomalyDetectorArn": "An anomaly detector ARN.
", "GetAnomalyGroupRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", + "GetDataQualityMetricsRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.
", + "GetDataQualityMetricsRequest$MetricSetArn": "The Amazon Resource Name (ARN) of a specific data quality metric set.
", "GetFeedbackRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "LambdaConfiguration$RoleArn": "The ARN of an IAM role that has permission to invoke the Lambda function.
", "LambdaConfiguration$LambdaArn": "The ARN of the Lambda function.
", @@ -266,6 +281,7 @@ "ListAnomalyGroupTimeSeriesRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", "ListMetricSetsRequest$AnomalyDetectorArn": "The ARN of the anomaly detector containing the metrics sets to list.
", "ListTagsForResourceRequest$ResourceArn": "The resource's Amazon Resource Name (ARN).
", + "MetricSetDataQualityMetric$MetricSetArn": "The Amazon Resource Name (ARN) of the data quality metric array.
", "MetricSetSummary$MetricSetArn": "The ARN of the dataset.
", "MetricSetSummary$AnomalyDetectorArn": "The ARN of the detector to which the dataset belongs.
", "PutFeedbackRequest$AnomalyDetectorArn": "The Amazon Resource Name (ARN) of the anomaly detector.
", @@ -469,6 +485,30 @@ "SampleRow$member": null } }, + "DataQualityMetric": { + "base": "An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.
A description of the data quality metric.
" + } + }, + "DataQualityMetricList": { + "base": null, + "refs": { + "MetricSetDataQualityMetric$DataQualityMetricList": "The array of data quality metrics contained in the data quality metric set.
" + } + }, + "DataQualityMetricType": { + "base": null, + "refs": { + "DataQualityMetric$MetricType": "The name of the data quality metric.
" + } + }, "DatabaseHost": { "base": null, "refs": { @@ -696,6 +736,12 @@ "DimensionFilter$DimensionValueList": "The list of values for the dimension specified in DimensionName that you want to filter on.
" } }, + "Double": { + "base": null, + "refs": { + "DataQualityMetric$MetricValue": "The value of the data quality metric.
" + } + }, "ErrorMessage": { "base": null, "refs": { @@ -753,6 +799,16 @@ "refs": { } }, + "GetDataQualityMetricsRequest": { + "base": null, + "refs": { + } + }, + "GetDataQualityMetricsResponse": { + "base": null, + "refs": { + } + }, "GetFeedbackRequest": { "base": null, "refs": { @@ -1015,6 +1071,18 @@ "AlertFilters$MetricList": "The list of measures that you want to get alerts for.
" } }, + "MetricSetDataQualityMetric": { + "base": "An array of DataQualityMetric objects that describes one or more data quality metrics.
An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric.
After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
", - "DescribeMetricSetResponse$Offset": "The offset in seconds. Only supported for S3 and Redshift datasources.
", - "UpdateMetricSetRequest$Offset": "After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
" + "CreateMetricSetRequest$Offset": "After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
", + "DescribeMetricSetResponse$Offset": "After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
", + "UpdateMetricSetRequest$Offset": "After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
" } }, "PoirotSecretManagerArn": { @@ -1177,6 +1245,12 @@ "MetricSource$RedshiftSourceConfig": "Details about an Amazon Redshift database datasource.
" } }, + "RelatedColumnName": { + "base": null, + "refs": { + "DataQualityMetric$RelatedColumnName": "The column that is being monitored.
" + } + }, "RelationshipType": { "base": null, "refs": { @@ -1410,6 +1484,7 @@ "Alert$CreationTime": "The time at which the alert was created.
", "AlertSummary$LastModificationTime": "The time at which the alert was last modified.
", "AlertSummary$CreationTime": "The time at which the alert was created.
", + "AnomalyDetectorDataQualityMetric$StartTimestamp": "The start time for the data quality metrics collection.
", "AnomalyDetectorSummary$CreationTime": "The time at which the detector was created.
", "AnomalyDetectorSummary$LastModificationTime": "The time at which the detector was last modified.
", "DescribeAnomalyDetectorResponse$CreationTime": "The time at which the detector was created.
", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 274dd04792..7a2fdea478 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -10614,6 +10614,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -19135,6 +19136,12 @@ } } }, + "wellarchitected" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "workspaces" : { "endpoints" : { "fips-us-gov-west-1" : { @@ -19241,6 +19248,7 @@ }, "appconfigdata" : { "endpoints" : { + "us-iso-east-1" : { }, "us-iso-west-1" : { } } }, @@ -19752,6 +19760,11 @@ "us-isob-east-1" : { } } }, + "appconfigdata" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "application-autoscaling" : { "defaults" : { "protocols" : [ "http", "https" ] diff --git a/service/connect/api.go b/service/connect/api.go index 05fc9632ca..ba14fc11f9 100644 --- a/service/connect/api.go +++ b/service/connect/api.go @@ -657,8 +657,7 @@ func (c *Connect) AssociatePhoneNumberContactFlowRequest(input *AssociatePhoneNu // AssociatePhoneNumberContactFlow API operation for Amazon Connect Service. // -// Associates a contact flow with a phone number claimed to your Amazon Connect -// instance. +// Associates a flow with a phone number claimed to your Amazon Connect instance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1230,10 +1229,10 @@ func (c *Connect) CreateContactFlowRequest(input *CreateContactFlowInput) (req * // CreateContactFlow API operation for Amazon Connect Service. // -// Creates a contact flow for the specified Amazon Connect instance. +// Creates a flow for the specified Amazon Connect instance. // -// You can also create and update contact flows using the Amazon Connect Flow -// language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// You can also create and update flows using the Amazon Connect Flow language +// (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1248,7 +1247,7 @@ func (c *Connect) CreateContactFlowRequest(input *CreateContactFlowInput) (req * // The request is not valid. // // - InvalidContactFlowException -// The contact flow is not valid. +// The flow is not valid. // // - InvalidParameterException // One or more of the specified parameters are not valid. @@ -1333,7 +1332,7 @@ func (c *Connect) CreateContactFlowModuleRequest(input *CreateContactFlowModuleI // CreateContactFlowModule API operation for Amazon Connect Service. // -// Creates a contact flow module for the specified Amazon Connect instance. +// Creates a flow module for the specified Amazon Connect instance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2136,6 +2135,7 @@ func (c *Connect) CreateTaskTemplateRequest(input *CreateTaskTemplateInput) (req // Returned Error Types: // // - PropertyValidationException +// The property is not valid. // // - InvalidParameterException // One or more of the specified parameters are not valid. @@ -2607,7 +2607,7 @@ func (c *Connect) DeleteContactFlowRequest(input *DeleteContactFlowInput) (req * // DeleteContactFlow API operation for Amazon Connect Service. // -// Deletes a contact flow for the specified Amazon Connect instance. +// Deletes a flow for the specified Amazon Connect instance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2702,7 +2702,7 @@ func (c *Connect) DeleteContactFlowModuleRequest(input *DeleteContactFlowModuleI // DeleteContactFlowModule API operation for Amazon Connect Service. // -// Deletes the specified contact flow module. +// Deletes the specified flow module. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3922,10 +3922,10 @@ func (c *Connect) DescribeContactFlowRequest(input *DescribeContactFlowInput) (r // DescribeContactFlow API operation for Amazon Connect Service. // -// Describes the specified contact flow. +// Describes the specified flow. // -// You can also create and update contact flows using the Amazon Connect Flow -// language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// You can also create and update flows using the Amazon Connect Flow language +// (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3946,7 +3946,7 @@ func (c *Connect) DescribeContactFlowRequest(input *DescribeContactFlowInput) (r // The specified resource was not found. // // - ContactFlowNotPublishedException -// The contact flow has not been published. +// The flow has not been published. // // - ThrottlingException // The throttling limit has been exceeded. @@ -4019,7 +4019,7 @@ func (c *Connect) DescribeContactFlowModuleRequest(input *DescribeContactFlowMod // DescribeContactFlowModule API operation for Amazon Connect Service. // -// Describes the specified contact flow module. +// Describes the specified flow module. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5596,7 +5596,7 @@ func (c *Connect) DisassociateLambdaFunctionRequest(input *DisassociateLambdaFun // 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 -// contact flow blocks. +// flow blocks. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5783,8 +5783,8 @@ func (c *Connect) DisassociatePhoneNumberContactFlowRequest(input *DisassociateP // DisassociatePhoneNumberContactFlow API operation for Amazon Connect Service. // -// Removes the contact flow association from a phone number claimed to your -// Amazon Connect instance, if a contact flow association exists. +// Removes the flow association from a phone number claimed to your Amazon Connect +// instance, if a flow association exists. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7337,8 +7337,8 @@ func (c *Connect) ListContactFlowModulesRequest(input *ListContactFlowModulesInp // ListContactFlowModules API operation for Amazon Connect Service. // -// Provides information about the contact flow modules for the specified Amazon -// Connect instance. +// Provides information about the flow modules for the specified Amazon Connect +// instance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7489,13 +7489,12 @@ func (c *Connect) ListContactFlowsRequest(input *ListContactFlowsInput) (req *re // ListContactFlows API operation for Amazon Connect Service. // -// Provides information about the contact flows for the specified Amazon Connect -// instance. +// Provides information about the flows for the specified Amazon Connect instance. // -// You can also create and update contact flows using the Amazon Connect Flow -// language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// You can also create and update flows using the Amazon Connect Flow language +// (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). // -// For more information about contact flows, see Contact Flows (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) +// For more information about flows, see Flows (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) // in the Amazon Connect Administrator Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -8687,7 +8686,7 @@ func (c *Connect) ListLambdaFunctionsRequest(input *ListLambdaFunctionsInput) (r // 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 contact flow blocks. +// options in the relevant flow blocks. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11721,6 +11720,156 @@ func (c *Connect) SearchAvailablePhoneNumbersPagesWithContext(ctx aws.Context, i return p.Err() } +const opSearchSecurityProfiles = "SearchSecurityProfiles" + +// SearchSecurityProfilesRequest generates a "aws/request.Request" representing the +// client's request for the SearchSecurityProfiles operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SearchSecurityProfiles for more information on using the SearchSecurityProfiles +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the SearchSecurityProfilesRequest method. +// req, resp := client.SearchSecurityProfilesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchSecurityProfiles +func (c *Connect) SearchSecurityProfilesRequest(input *SearchSecurityProfilesInput) (req *request.Request, output *SearchSecurityProfilesOutput) { + op := &request.Operation{ + Name: opSearchSecurityProfiles, + HTTPMethod: "POST", + HTTPPath: "/search-security-profiles", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchSecurityProfilesInput{} + } + + output = &SearchSecurityProfilesOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchSecurityProfiles API operation for Amazon Connect Service. +// +// This API is in preview release for Amazon Connect and is subject to change. +// +// Searches security profiles in an Amazon Connect instance, with optional filtering. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Connect Service's +// API operation SearchSecurityProfiles for usage and error information. +// +// Returned Error Types: +// +// - InvalidRequestException +// The request is not valid. +// +// - InvalidParameterException +// One or more of the specified parameters are not valid. +// +// - ResourceNotFoundException +// The specified resource was not found. +// +// - ThrottlingException +// The throttling limit has been exceeded. +// +// - InternalServiceException +// Request processing failed because of an error or failure with the service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchSecurityProfiles +func (c *Connect) SearchSecurityProfiles(input *SearchSecurityProfilesInput) (*SearchSecurityProfilesOutput, error) { + req, out := c.SearchSecurityProfilesRequest(input) + return out, req.Send() +} + +// SearchSecurityProfilesWithContext is the same as SearchSecurityProfiles with the addition of +// the ability to pass a context and additional request options. +// +// See SearchSecurityProfiles for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchSecurityProfilesWithContext(ctx aws.Context, input *SearchSecurityProfilesInput, opts ...request.Option) (*SearchSecurityProfilesOutput, error) { + req, out := c.SearchSecurityProfilesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchSecurityProfilesPages iterates over the pages of a SearchSecurityProfiles operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchSecurityProfiles method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a SearchSecurityProfiles operation. +// pageNum := 0 +// err := client.SearchSecurityProfilesPages(params, +// func(page *connect.SearchSecurityProfilesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *Connect) SearchSecurityProfilesPages(input *SearchSecurityProfilesInput, fn func(*SearchSecurityProfilesOutput, bool) bool) error { + return c.SearchSecurityProfilesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchSecurityProfilesPagesWithContext same as SearchSecurityProfilesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Connect) SearchSecurityProfilesPagesWithContext(ctx aws.Context, input *SearchSecurityProfilesInput, fn func(*SearchSecurityProfilesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchSecurityProfilesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchSecurityProfilesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchSecurityProfilesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opSearchUsers = "SearchUsers" // SearchUsersRequest generates a "aws/request.Request" representing the @@ -12058,8 +12207,8 @@ func (c *Connect) StartChatContactRequest(input *StartChatContactInput) (req *re // StartChatContact API operation for Amazon Connect Service. // -// Initiates a contact flow to start a new chat for the customer. Response of -// this API provides a token required to obtain credentials from the CreateParticipantConnection +// 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 // (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) // API in the Amazon Connect Participant Service. // @@ -12374,13 +12523,13 @@ func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceCont // StartOutboundVoiceContact API operation for Amazon Connect Service. // -// Places an outbound call to a contact, and then initiates the contact flow. -// It performs the actions in the contact flow that's specified (in ContactFlowId). +// 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 contact 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. +// 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. @@ -12391,9 +12540,8 @@ func (c *Connect) StartOutboundVoiceContactRequest(input *StartOutboundVoiceCont // 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. -// For more information, see Amazon Connect Service Quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) -// in the Amazon Connect Administrator Guide. +// TrafficType = CAMPAIGN, you must submit a service quota increase request +// to the quota Amazon Connect campaigns (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12490,7 +12638,7 @@ func (c *Connect) StartTaskContactRequest(input *StartTaskContactInput) (req *re // StartTaskContact API operation for Amazon Connect Service. // -// Initiates a contact flow to start a new task. +// Initiates a flow to start a new task. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12964,9 +13112,10 @@ func (c *Connect) TagResourceRequest(input *TagResourceInput) (req *request.Requ // // Adds the specified tags to the specified resource. // -// The supported resource types are users, routing profiles, queues, quick connects, -// contact flows, agent status, hours of operation, phone number, security profiles, -// and task templates. +// 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 (https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html). // // For sample policies that use tags, see Amazon Connect Identity-Based Policy // Examples (https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) @@ -13063,9 +13212,9 @@ func (c *Connect) TransferContactRequest(input *TransferContactInput) (req *requ // // 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 contact 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. +// 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: // @@ -13073,8 +13222,8 @@ func (c *Connect) TransferContactRequest(input *TransferContactInput) (req *requ // // - Do not use both QueueId and UserId in the same call. // -// - The following contact flow types are supported: Inbound contact flow, -// Transfer to agent flow, and Transfer to queue flow. +// - 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. // @@ -13479,18 +13628,11 @@ func (c *Connect) UpdateContactAttributesRequest(input *UpdateContactAttributesI // identify abusive callers. // // Contact attributes are available in Amazon Connect for 24 months, and are -// then deleted. For information about CTR retention and the maximum size of -// the CTR attributes section, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) +// then deleted. For information about contact record retention and the maximum +// size of the contact record attributes section, see Feature specifications +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) // in the Amazon Connect Administrator Guide. // -// Important: You cannot use the operation to update attributes for contacts -// that occurred prior to the release of the API, which was September 12, 2018. -// You can update attributes only for contacts that started after the release -// of the API. If you attempt to update attributes for a contact that occurred -// prior to the release of the API, a 400 error is returned. This applies also -// to queued callbacks that were initiated prior to the release of the API but -// are still active in your instance. -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -13578,10 +13720,10 @@ func (c *Connect) UpdateContactFlowContentRequest(input *UpdateContactFlowConten // UpdateContactFlowContent API operation for Amazon Connect Service. // -// Updates the specified contact flow. +// Updates the specified flow. // -// You can also create and update contact flows using the Amazon Connect Flow -// language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// You can also create and update flows using the Amazon Connect Flow language +// (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13596,7 +13738,7 @@ func (c *Connect) UpdateContactFlowContentRequest(input *UpdateContactFlowConten // The request is not valid. // // - InvalidContactFlowException -// The contact flow is not valid. +// The flow is not valid. // // - InvalidParameterException // One or more of the specified parameters are not valid. @@ -13676,7 +13818,7 @@ func (c *Connect) UpdateContactFlowMetadataRequest(input *UpdateContactFlowMetad // UpdateContactFlowMetadata API operation for Amazon Connect Service. // -// Updates metadata about specified contact flow. +// Updates metadata about specified flow. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13771,7 +13913,7 @@ func (c *Connect) UpdateContactFlowModuleContentRequest(input *UpdateContactFlow // UpdateContactFlowModuleContent API operation for Amazon Connect Service. // -// Updates specified contact flow module for the specified Amazon Connect instance. +// Updates specified flow module for the specified Amazon Connect instance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13866,7 +14008,7 @@ func (c *Connect) UpdateContactFlowModuleMetadataRequest(input *UpdateContactFlo // UpdateContactFlowModuleMetadata API operation for Amazon Connect Service. // -// Updates metadata about specified contact flow module. +// Updates metadata about specified flow module. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13964,10 +14106,10 @@ func (c *Connect) UpdateContactFlowNameRequest(input *UpdateContactFlowNameInput // UpdateContactFlowName API operation for Amazon Connect Service. // -// The name of the contact flow. +// The name of the flow. // -// You can also create and update contact flows using the Amazon Connect Flow -// language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// You can also create and update flows using the Amazon Connect Flow language +// (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -15681,6 +15823,7 @@ func (c *Connect) UpdateTaskTemplateRequest(input *UpdateTaskTemplateInput) (req // Returned Error Types: // // - PropertyValidationException +// The property is not valid. // // - InvalidParameterException // One or more of the specified parameters are not valid. @@ -16592,7 +16735,8 @@ type AgentStatus struct { // The state of the agent status. State *string `type:"string" enum:"AgentStatusState"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The type of agent status. @@ -17385,7 +17529,7 @@ func (s AssociateLexBotOutput) GoString() string { type AssociatePhoneNumberContactFlowInput struct { _ struct{} `type:"structure"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `type:"string" required:"true"` @@ -18084,7 +18228,8 @@ type ClaimPhoneNumberInput struct { // The description of the phone number. PhoneNumberDescription *string `type:"string"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers @@ -18228,7 +18373,8 @@ type ClaimedPhoneNumberSummary struct { // The type of phone number. PhoneNumberType *string `type:"string" enum:"PhoneNumberType"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers @@ -18497,33 +18643,34 @@ func (s *ContactFilter) SetContactStates(v []*string) *ContactFilter { return s } -// Contains information about a contact flow. +// Contains information about a flow. type ContactFlow struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the contact flow. + // The Amazon Resource Name (ARN) of the flow. Arn *string `type:"string"` - // The content of the contact flow. + // The content of the flow. Content *string `type:"string"` - // The description of the contact flow. + // The description of the flow. Description *string `type:"string"` - // The identifier of the contact flow. + // The identifier of the flow. Id *string `type:"string"` - // The name of the contact flow. + // The name of the flow. Name *string `min:"1" type:"string"` - // The type of contact flow. + // The type of flow. State *string `type:"string" enum:"ContactFlowState"` - // One or more tags. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` - // The type of the contact flow. For descriptions of the available types, see - // Choose a Contact Flow Type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) + // The type of the flow. For descriptions of the available types, see Choose + // a flow type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) // in the Amazon Connect Administrator Guide. Type *string `type:"string" enum:"ContactFlowType"` } @@ -18594,32 +18741,33 @@ func (s *ContactFlow) SetType(v string) *ContactFlow { return s } -// Contains information about a contact flow module. +// Contains information about a flow module. type ContactFlowModule struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN). Arn *string `type:"string"` - // The content of the contact flow module. + // The content of the flow module. Content *string `min:"1" type:"string"` - // The description of the contact flow module. + // The description of the flow module. Description *string `type:"string"` - // The identifier of the contact flow module. + // The identifier of the flow module. Id *string `min:"1" type:"string"` - // The name of the contact flow module. + // The name of the flow module. Name *string `min:"1" type:"string"` - // The type of contact flow module. + // The type of flow module. State *string `type:"string" enum:"ContactFlowModuleState"` - // The status of the contact flow module. + // The status of the flow module. Status *string `type:"string" enum:"ContactFlowModuleStatus"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -18689,20 +18837,20 @@ func (s *ContactFlowModule) SetTags(v map[string]*string) *ContactFlowModule { return s } -// Contains summary information about a contact flow. +// Contains summary information about a flow. type ContactFlowModuleSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the contact flow module. + // The Amazon Resource Name (ARN) of the flow module. Arn *string `type:"string"` - // The identifier of the contact flow module. + // The identifier of the flow module. Id *string `min:"1" type:"string"` - // The name of the contact flow module. + // The name of the flow module. Name *string `min:"1" type:"string"` - // The type of contact flow module. + // The type of flow module. State *string `type:"string" enum:"ContactFlowModuleState"` } @@ -18748,7 +18896,7 @@ func (s *ContactFlowModuleSummary) SetState(v string) *ContactFlowModuleSummary return s } -// The contact flow has not been published. +// The flow has not been published. type ContactFlowNotPublishedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -18812,26 +18960,26 @@ func (s *ContactFlowNotPublishedException) RequestID() string { return s.RespMetadata.RequestID } -// Contains summary information about a contact flow. +// Contains summary information about a flow. // -// You can also create and update contact flows using the Amazon Connect Flow -// language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// You can also create and update flows using the Amazon Connect Flow language +// (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). type ContactFlowSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the contact flow. + // The Amazon Resource Name (ARN) of the flow. Arn *string `type:"string"` - // The type of contact flow. + // The type of flow. ContactFlowState *string `type:"string" enum:"ContactFlowState"` - // The type of contact flow. + // The type of flow. ContactFlowType *string `type:"string" enum:"ContactFlowType"` - // The identifier of the contact flow. + // The identifier of the flow. Id *string `type:"string"` - // The name of the contact flow. + // The name of the flow. Name *string `min:"1" type:"string"` } @@ -19029,7 +19177,8 @@ type CreateAgentStatusInput struct { // State is a required field State *string `type:"string" required:"true" enum:"AgentStatusState"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -19164,12 +19313,12 @@ func (s *CreateAgentStatusOutput) SetAgentStatusId(v string) *CreateAgentStatusO type CreateContactFlowInput struct { _ struct{} `type:"structure"` - // The content of the contact flow. + // The content of the flow. // // Content is a required field Content *string `type:"string" required:"true"` - // The description of the contact flow. + // The description of the flow. Description *string `type:"string"` // The identifier of the Amazon Connect instance. @@ -19177,16 +19326,17 @@ type CreateContactFlowInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The name of the contact flow. + // The name of the flow. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` - // One or more tags. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` - // The type of the contact flow. For descriptions of the available types, see - // Choose a Contact Flow Type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) + // The type of the flow. For descriptions of the available types, see Choose + // a flow type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) // in the Amazon Connect Administrator Guide. // // Type is a required field @@ -19285,12 +19435,12 @@ type CreateContactFlowModuleInput struct { // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` - // The content of the contact flow module. + // The content of the flow module. // // Content is a required field Content *string `min:"1" type:"string" required:"true"` - // The description of the contact flow module. + // The description of the flow module. Description *string `type:"string"` // The identifier of the Amazon Connect instance. You can find the instanceId @@ -19299,12 +19449,13 @@ type CreateContactFlowModuleInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The name of the contact flow module. + // The name of the flow module. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -19396,10 +19547,10 @@ func (s *CreateContactFlowModuleInput) SetTags(v map[string]*string) *CreateCont type CreateContactFlowModuleOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the contact flow module. + // The Amazon Resource Name (ARN) of the flow module. Arn *string `type:"string"` - // The identifier of the contact flow module. + // The identifier of the flow module. Id *string `min:"1" type:"string"` } @@ -19436,10 +19587,10 @@ func (s *CreateContactFlowModuleOutput) SetId(v string) *CreateContactFlowModule type CreateContactFlowOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the contact flow. + // The Amazon Resource Name (ARN) of the flow. ContactFlowArn *string `type:"string"` - // The identifier of the contact flow. + // The identifier of the flow. ContactFlowId *string `type:"string"` } @@ -19496,7 +19647,8 @@ type CreateHoursOfOperationInput struct { // Name is a required field Name *string `min:"1" type:"string" required:"true"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The time zone of the hours of operation. @@ -19805,6 +19957,9 @@ type CreateIntegrationAssociationInput struct { // The Amazon Resource Name (ARN) of the integration. // + // When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint + // instances must be in the same account. + // // IntegrationArn is a required field IntegrationArn *string `type:"string" required:"true"` @@ -19825,7 +19980,8 @@ type CreateIntegrationAssociationInput struct { // type. SourceType *string `type:"string" enum:"SourceType"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -19992,7 +20148,8 @@ type CreateQueueInput struct { // The quick connects available to agents who are working the queue. QuickConnectIds []*string `min:"1" type:"list"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -20163,7 +20320,8 @@ type CreateQuickConnectInput struct { // QuickConnectConfig is a required field QuickConnectConfig *QuickConnectConfig `type:"structure" required:"true"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -20325,7 +20483,8 @@ type CreateRoutingProfileInput struct { // the agent can make only outbound calls. QueueConfigs []*RoutingProfileQueueConfig `min:"1" type:"list"` - // One or more tags. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -20509,7 +20668,8 @@ type CreateSecurityProfileInput struct { // SecurityProfileName is a required field SecurityProfileName *string `type:"string" required:"true"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -20844,7 +21004,8 @@ type CreateUseCaseInput struct { // IntegrationAssociationId is a required field IntegrationAssociationId *string `location:"uri" locationName:"IntegrationAssociationId" min:"1" type:"string" required:"true"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The type of use case to associate to the integration association. Each integration @@ -20982,7 +21143,8 @@ type CreateUserHierarchyGroupInput struct { // at level one if the parent group ID is null. ParentGroupId *string `type:"string"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -21137,7 +21299,8 @@ type CreateUserInput struct { // SecurityProfileIds is a required field SecurityProfileIds []*string `min:"1" type:"list" required:"true"` - // One or more tags. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The user name for the account. For instances not using SAML for identity @@ -21344,7 +21507,8 @@ type CreateVocabularyInput struct { // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"VocabularyLanguageCode"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // A unique name of the custom vocabulary. @@ -21803,7 +21967,7 @@ func (s *DefaultVocabulary) SetVocabularyName(v string) *DefaultVocabulary { type DeleteContactFlowInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `location:"uri" locationName:"ContactFlowId" type:"string" required:"true"` @@ -21870,7 +22034,7 @@ func (s *DeleteContactFlowInput) SetInstanceId(v string) *DeleteContactFlowInput type DeleteContactFlowModuleInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the contact flow module. + // The identifier of the flow module. // // ContactFlowModuleId is a required field ContactFlowModuleId *string `location:"uri" locationName:"ContactFlowModuleId" min:"1" type:"string" required:"true"` @@ -23002,7 +23166,7 @@ func (s *DescribeAgentStatusOutput) SetAgentStatus(v *AgentStatus) *DescribeAgen type DescribeContactFlowInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `location:"uri" locationName:"ContactFlowId" type:"string" required:"true"` @@ -23068,7 +23232,7 @@ func (s *DescribeContactFlowInput) SetInstanceId(v string) *DescribeContactFlowI type DescribeContactFlowModuleInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the contact flow module. + // The identifier of the flow module. // // ContactFlowModuleId is a required field ContactFlowModuleId *string `location:"uri" locationName:"ContactFlowModuleId" min:"1" type:"string" required:"true"` @@ -23135,7 +23299,7 @@ func (s *DescribeContactFlowModuleInput) SetInstanceId(v string) *DescribeContac type DescribeContactFlowModuleOutput struct { _ struct{} `type:"structure"` - // Information about the contact flow module. + // Information about the flow module. ContactFlowModule *ContactFlowModule `type:"structure"` } @@ -23166,7 +23330,7 @@ func (s *DescribeContactFlowModuleOutput) SetContactFlowModule(v *ContactFlowMod type DescribeContactFlowOutput struct { _ struct{} `type:"structure"` - // Information about the contact flow. + // Information about the flow. ContactFlow *ContactFlow `type:"structure"` } @@ -26816,7 +26980,8 @@ type GetTaskTemplateOutput struct { // then a task that refers to this template cannot be created. Status *string `type:"string" enum:"TaskTemplateStatus"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -26935,7 +27100,8 @@ type HierarchyGroup struct { // The name of the hierarchy group. Name *string `type:"string"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -27691,7 +27857,8 @@ type HoursOfOperation struct { // The name for the hours of operation. Name *string `min:"1" type:"string"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The time zone for the hours of operation. @@ -28553,14 +28720,14 @@ func (s *InternalServiceException) RequestID() string { return s.RespMetadata.RequestID } -// The contact flow is not valid. +// The flow is not valid. type InvalidContactFlowException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` - // The problems with the contact flow. Please fix before trying again. + // The problems with the flow. Please fix before trying again. Problems []*ProblemDetail `locationName:"problems" min:"1" type:"list"` } @@ -29598,7 +29765,7 @@ func (s *ListBotsOutput) SetNextToken(v string) *ListBotsOutput { type ListContactFlowModulesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The state of the contact flow module. + // The state of the flow module. ContactFlowModuleState *string `location:"querystring" locationName:"state" type:"string" enum:"ContactFlowModuleState"` // The identifier of the Amazon Connect instance. You can find the instanceId @@ -29679,7 +29846,7 @@ func (s *ListContactFlowModulesInput) SetNextToken(v string) *ListContactFlowMod type ListContactFlowModulesOutput struct { _ struct{} `type:"structure"` - // Information about the contact flow module. + // Information about the flow module. ContactFlowModulesSummaryList []*ContactFlowModuleSummary `type:"list"` // If there are additional results, this is the token for the next set of results. @@ -29719,7 +29886,7 @@ func (s *ListContactFlowModulesOutput) SetNextToken(v string) *ListContactFlowMo type ListContactFlowsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The type of contact flow. + // The type of flow. ContactFlowTypes []*string `location:"querystring" locationName:"contactFlowTypes" type:"list" enum:"ContactFlowType"` // The identifier of the Amazon Connect instance. You can find the instanceId @@ -29728,7 +29895,8 @@ type ListContactFlowsInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -29800,7 +29968,7 @@ func (s *ListContactFlowsInput) SetNextToken(v string) *ListContactFlowsInput { type ListContactFlowsOutput struct { _ struct{} `type:"structure"` - // Information about the contact flows. + // Information about the flows. ContactFlowSummaryList []*ContactFlowSummary `type:"list"` // If there are additional results, this is the token for the next set of results. @@ -29939,7 +30107,7 @@ type ListContactReferencesOutput struct { // This is always returned as null in the response. NextToken *string `type:"string"` - // Information about the contact flows. + // Information about the flows. ReferenceSummaryList []*ReferenceSummary `type:"list"` } @@ -30109,7 +30277,8 @@ type ListHoursOfOperationsInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -30900,7 +31069,8 @@ type ListPhoneNumbersInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -31246,7 +31416,8 @@ type ListPromptsInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -31358,7 +31529,8 @@ type ListQueueQuickConnectsInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -31487,7 +31659,8 @@ type ListQueuesInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -31608,7 +31781,8 @@ type ListQuickConnectsInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -31731,7 +31905,8 @@ type ListRoutingProfileQueuesInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -31860,7 +32035,8 @@ type ListRoutingProfilesInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -32213,7 +32389,8 @@ type ListSecurityProfilesInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -32678,7 +32855,8 @@ type ListUserHierarchyGroupsInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -32790,7 +32968,8 @@ type ListUsersInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The maximum number of results to return per page. + // The maximum number of results to return per page. The default MaxResult size + // is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token for the next set of results. Use the value returned in the previous @@ -33422,6 +33601,7 @@ func (s *PromptSummary) SetName(v string) *PromptSummary { return s } +// The property is not valid. type PropertyValidationException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -33675,7 +33855,8 @@ type Queue struct { // The status of the queue. Status *string `type:"string" enum:"QueueStatus"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -33792,12 +33973,12 @@ func (s *QueueInfo) SetId(v string) *QueueInfo { return s } -// Contains information about a queue for a quick connect. The contact flow -// must be of type Transfer to Queue. +// Contains information about a queue for a quick connect. The flow must be +// of type Transfer to Queue. type QueueQuickConnectConfig struct { _ struct{} `type:"structure"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `type:"string" required:"true"` @@ -33973,7 +34154,8 @@ type QuickConnect struct { // The identifier for the quick connect. QuickConnectId *string `type:"string"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -34839,7 +35021,8 @@ type RoutingProfile struct { // The identifier of the routing profile. RoutingProfileId *string `type:"string"` - // One or more tags. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -35475,6 +35658,148 @@ func (s *SearchAvailablePhoneNumbersOutput) SetNextToken(v string) *SearchAvaila return s } +type SearchSecurityProfilesInput struct { + _ struct{} `type:"structure"` + + // The identifier of the Amazon Connect instance. You can find the instanceId + // in the ARN of the instance. + // + // InstanceId is a required field + InstanceId *string `min:"1" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `min:"1" type:"integer"` + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string `min:"1" type:"string"` + + // The search criteria to be used to return security profiles. + SearchCriteria *SecurityProfileSearchCriteria `type:"structure"` + + // Filters to be applied to search results. + SearchFilter *SecurityProfilesSearchFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSecurityProfilesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSecurityProfilesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchSecurityProfilesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchSecurityProfilesInput"} + if s.InstanceId == nil { + invalidParams.Add(request.NewErrParamRequired("InstanceId")) + } + if s.InstanceId != nil && len(*s.InstanceId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("InstanceId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetInstanceId sets the InstanceId field's value. +func (s *SearchSecurityProfilesInput) SetInstanceId(v string) *SearchSecurityProfilesInput { + s.InstanceId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchSecurityProfilesInput) SetMaxResults(v int64) *SearchSecurityProfilesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchSecurityProfilesInput) SetNextToken(v string) *SearchSecurityProfilesInput { + s.NextToken = &v + return s +} + +// SetSearchCriteria sets the SearchCriteria field's value. +func (s *SearchSecurityProfilesInput) SetSearchCriteria(v *SecurityProfileSearchCriteria) *SearchSecurityProfilesInput { + s.SearchCriteria = v + return s +} + +// SetSearchFilter sets the SearchFilter field's value. +func (s *SearchSecurityProfilesInput) SetSearchFilter(v *SecurityProfilesSearchFilter) *SearchSecurityProfilesInput { + s.SearchFilter = v + return s +} + +type SearchSecurityProfilesOutput struct { + _ struct{} `type:"structure"` + + // The total number of security profiles which matched your search query. + ApproximateTotalCount *int64 `type:"long"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `min:"1" type:"string"` + + // Information about the security profiles. + SecurityProfiles []*SecurityProfileSearchSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSecurityProfilesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSecurityProfilesOutput) GoString() string { + return s.String() +} + +// SetApproximateTotalCount sets the ApproximateTotalCount field's value. +func (s *SearchSecurityProfilesOutput) SetApproximateTotalCount(v int64) *SearchSecurityProfilesOutput { + s.ApproximateTotalCount = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchSecurityProfilesOutput) SetNextToken(v string) *SearchSecurityProfilesOutput { + s.NextToken = &v + return s +} + +// SetSecurityProfiles sets the SecurityProfiles field's value. +func (s *SearchSecurityProfilesOutput) SetSecurityProfiles(v []*SecurityProfileSearchSummary) *SearchSecurityProfilesOutput { + s.SecurityProfiles = v + return s +} + type SearchUsersInput struct { _ struct{} `type:"structure"` @@ -35828,7 +36153,8 @@ type SecurityProfile struct { // The name for the security profile. SecurityProfileName *string `type:"string"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } @@ -35886,6 +36212,135 @@ func (s *SecurityProfile) SetTags(v map[string]*string) *SecurityProfile { return s } +// The search criteria to be used to return security profiles. +type SecurityProfileSearchCriteria struct { + _ struct{} `type:"structure"` + + // A list of conditions which would be applied together with an AND condition. + AndConditions []*SecurityProfileSearchCriteria `type:"list"` + + // A list of conditions which would be applied together with an OR condition. + OrConditions []*SecurityProfileSearchCriteria `type:"list"` + + // A leaf node condition which can be used to specify a string condition, for + // example, username = 'abc'. + StringCondition *StringCondition `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecurityProfileSearchCriteria) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecurityProfileSearchCriteria) GoString() string { + return s.String() +} + +// SetAndConditions sets the AndConditions field's value. +func (s *SecurityProfileSearchCriteria) SetAndConditions(v []*SecurityProfileSearchCriteria) *SecurityProfileSearchCriteria { + s.AndConditions = v + return s +} + +// SetOrConditions sets the OrConditions field's value. +func (s *SecurityProfileSearchCriteria) SetOrConditions(v []*SecurityProfileSearchCriteria) *SecurityProfileSearchCriteria { + s.OrConditions = v + return s +} + +// SetStringCondition sets the StringCondition field's value. +func (s *SecurityProfileSearchCriteria) SetStringCondition(v *StringCondition) *SecurityProfileSearchCriteria { + s.StringCondition = v + return s +} + +// Information about the returned security profiles. +type SecurityProfileSearchSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the security profile. + Arn *string `type:"string"` + + // The description of the security profile. + Description *string `type:"string"` + + // The identifier of the security profile. + Id *string `type:"string"` + + // The organization resource identifier. + OrganizationResourceId *string `min:"1" type:"string"` + + // The name of the security profile. + SecurityProfileName *string `type:"string"` + + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. + Tags map[string]*string `min:"1" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecurityProfileSearchSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecurityProfileSearchSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *SecurityProfileSearchSummary) SetArn(v string) *SecurityProfileSearchSummary { + s.Arn = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *SecurityProfileSearchSummary) SetDescription(v string) *SecurityProfileSearchSummary { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *SecurityProfileSearchSummary) SetId(v string) *SecurityProfileSearchSummary { + s.Id = &v + return s +} + +// SetOrganizationResourceId sets the OrganizationResourceId field's value. +func (s *SecurityProfileSearchSummary) SetOrganizationResourceId(v string) *SecurityProfileSearchSummary { + s.OrganizationResourceId = &v + return s +} + +// SetSecurityProfileName sets the SecurityProfileName field's value. +func (s *SecurityProfileSearchSummary) SetSecurityProfileName(v string) *SecurityProfileSearchSummary { + s.SecurityProfileName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *SecurityProfileSearchSummary) SetTags(v map[string]*string) *SecurityProfileSearchSummary { + s.Tags = v + return s +} + // Contains information about a security profile. type SecurityProfileSummary struct { _ struct{} `type:"structure"` @@ -35936,6 +36391,44 @@ func (s *SecurityProfileSummary) SetName(v string) *SecurityProfileSummary { return s } +// Filters to be applied to search results. +type SecurityProfilesSearchFilter struct { + _ struct{} `type:"structure"` + + // An object that can be used to specify Tag conditions inside the SearchFilter. + // This accepts an OR of AND (List of List) input where: + // + // * Top level list specifies conditions that need to be applied with OR + // operator + // + // * Inner list specifies conditions that need to be applied with AND operator. + TagFilter *ControlPlaneTagFilter `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecurityProfilesSearchFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SecurityProfilesSearchFilter) GoString() string { + return s.String() +} + +// SetTagFilter sets the TagFilter field's value. +func (s *SecurityProfilesSearchFilter) SetTagFilter(v *ControlPlaneTagFilter) *SecurityProfilesSearchFilter { + s.TagFilter = v + return s +} + // The service quota has been exceeded. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` @@ -36004,8 +36497,8 @@ type StartChatContactInput struct { _ struct{} `type:"structure"` // A custom key-value pair using an attribute map. The attributes are standard - // Amazon Connect attributes. They can be accessed in contact flows just like - // any other contact attributes. + // Amazon Connect attributes. They can be accessed in flows just like any other + // contact attributes. // // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. @@ -36020,11 +36513,11 @@ type StartChatContactInput struct { // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` - // The identifier of the contact flow for initiating the chat. To see the ContactFlowId + // The identifier of the flow for initiating the chat. To see the ContactFlowId // in the Amazon Connect console user interface, on the navigation menu go to - // Routing, Contact Flows. Choose the contact flow. On the contact flow page, - // under the name of the contact flow, choose Show additional flow information. - // The ContactFlowId is the last part of the ARN, shown here in bold: + // Routing, Contact Flows. Choose the flow. On the flow page, under the name + // of the flow, choose Show additional flow information. The ContactFlowId is + // the last part of the ARN, shown here in bold: // // arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx // @@ -36461,8 +36954,8 @@ type StartOutboundVoiceContactInput struct { AnswerMachineDetectionConfig *AnswerMachineDetectionConfig `type:"structure"` // A custom key-value pair using an attribute map. The attributes are standard - // Amazon Connect attributes, and can be accessed in contact flows just like - // any other contact attributes. + // Amazon Connect attributes, and can be accessed in flows just like any other + // contact attributes. // // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. @@ -36476,11 +36969,11 @@ type StartOutboundVoiceContactInput struct { // is already started, the contact ID is returned. ClientToken *string `type:"string" idempotencyToken:"true"` - // The identifier of the contact flow for the outbound call. To see the ContactFlowId + // The identifier of the flow for the outbound call. To see the ContactFlowId // in the Amazon Connect console user interface, on the navigation menu go to - // Routing, Contact Flows. Choose the contact flow. On the contact flow page, - // under the name of the contact flow, choose Show additional flow information. - // The ContactFlowId is the last part of the ARN, shown here in bold: + // Routing, Contact Flows. Choose the flow. On the flow page, under the name + // of the flow, choose Show additional flow information. The ContactFlowId is + // the last part of the ARN, shown here in bold: // // arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx // @@ -36500,8 +36993,8 @@ type StartOutboundVoiceContactInput struct { // The queue for the call. If you specify a queue, the phone displayed for caller // ID is the phone number specified in the queue. If you do not specify a queue, - // the queue defined in the contact flow is used. If you do not specify a queue, - // you must specify a source phone number. + // the queue defined in the flow is used. If you do not specify a queue, you + // must specify a source phone number. QueueId *string `type:"string"` // The phone number associated with the Amazon Connect instance, in E.164 format. @@ -36653,8 +37146,8 @@ type StartTaskContactInput struct { _ struct{} `type:"structure"` // A custom key-value pair using an attribute map. The attributes are standard - // Amazon Connect attributes, and can be accessed in contact flows just like - // any other contact attributes. + // Amazon Connect attributes, and can be accessed in flows just like any other + // contact attributes. // // There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. @@ -36664,11 +37157,11 @@ type StartTaskContactInput struct { // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` - // The identifier of the contact flow for initiating the tasks. To see the ContactFlowId + // The identifier of the flow for initiating the tasks. To see the ContactFlowId // in the Amazon Connect console user interface, on the navigation menu go to - // Routing, Contact Flows. Choose the contact flow. On the contact flow page, - // under the name of the contact flow, choose Show additional flow information. - // The ContactFlowId is the last part of the ARN, shown here in bold: + // Routing, Contact Flows. Choose the flow. On the flow page, under the name + // of the flow, choose Show additional flow information. The ContactFlowId is + // the last part of the ARN, shown here in bold: // // arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx ContactFlowId *string `type:"string"` @@ -36699,8 +37192,8 @@ type StartTaskContactInput struct { References map[string]*Reference `type:"map"` // The timestamp, in Unix Epoch seconds format, at which to start running the - // inbound contact flow. The scheduled time cannot be in the past. It must be - // within up to 6 days in future. + // inbound flow. The scheduled time cannot be in the past. It must be within + // up to 6 days in future. ScheduledTime *time.Time `type:"timestamp"` // A unique identifier for the task template. @@ -37410,8 +37903,8 @@ type TagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` - // One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} - // }. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. // // Tags is a required field Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"` @@ -38016,7 +38509,7 @@ type TransferContactInput struct { // of the request. ClientToken *string `type:"string" idempotencyToken:"true"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `type:"string" required:"true"` @@ -38392,8 +38885,8 @@ func (s UpdateAgentStatusOutput) GoString() string { type UpdateContactAttributesInput struct { _ struct{} `type:"structure"` - // The Amazon Connect attributes. These attributes can be accessed in contact - // flows just like any other contact attributes. + // The Amazon Connect attributes. These attributes can be accessed in flows + // just like any other contact attributes. // // You can have up to 32,768 UTF-8 bytes across all attributes for a contact. // Attribute keys can include only alphanumeric, dash, and underscore characters. @@ -38500,13 +38993,13 @@ func (s UpdateContactAttributesOutput) GoString() string { type UpdateContactFlowContentInput struct { _ struct{} `type:"structure"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `location:"uri" locationName:"ContactFlowId" type:"string" required:"true"` - // The JSON string that represents contact flow’s content. For an example, - // see Example contact flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html) + // The JSON string that represents flow's content. For an example, see Example + // contact flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html) // in the Amazon Connect Administrator Guide. // // Content is a required field @@ -38604,15 +39097,15 @@ func (s UpdateContactFlowContentOutput) GoString() string { type UpdateContactFlowMetadataInput struct { _ struct{} `type:"structure"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `location:"uri" locationName:"ContactFlowId" type:"string" required:"true"` - // The state of contact flow. + // The state of flow. ContactFlowState *string `type:"string" enum:"ContactFlowState"` - // The description of the contact flow. + // The description of the flow. Description *string `type:"string"` // The identifier of the Amazon Connect instance. You can find the instanceId @@ -38621,7 +39114,7 @@ type UpdateContactFlowMetadataInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // TThe name of the contact flow. + // TThe name of the flow. Name *string `min:"1" type:"string"` } @@ -38723,12 +39216,12 @@ func (s UpdateContactFlowMetadataOutput) GoString() string { type UpdateContactFlowModuleContentInput struct { _ struct{} `type:"structure"` - // The identifier of the contact flow module. + // The identifier of the flow module. // // ContactFlowModuleId is a required field ContactFlowModuleId *string `location:"uri" locationName:"ContactFlowModuleId" min:"1" type:"string" required:"true"` - // The content of the contact flow module. + // The content of the flow module. // // Content is a required field Content *string `min:"1" type:"string" required:"true"` @@ -38829,12 +39322,12 @@ func (s UpdateContactFlowModuleContentOutput) GoString() string { type UpdateContactFlowModuleMetadataInput struct { _ struct{} `type:"structure"` - // The identifier of the contact flow module. + // The identifier of the flow module. // // ContactFlowModuleId is a required field ContactFlowModuleId *string `location:"uri" locationName:"ContactFlowModuleId" min:"1" type:"string" required:"true"` - // The description of the contact flow module. + // The description of the flow module. Description *string `type:"string"` // The identifier of the Amazon Connect instance. You can find the instanceId @@ -38843,10 +39336,10 @@ type UpdateContactFlowModuleMetadataInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The name of the contact flow module. + // The name of the flow module. Name *string `min:"1" type:"string"` - // The state of contact flow module. + // The state of flow module. State *string `type:"string" enum:"ContactFlowModuleState"` } @@ -38948,12 +39441,12 @@ func (s UpdateContactFlowModuleMetadataOutput) GoString() string { type UpdateContactFlowNameInput struct { _ struct{} `type:"structure"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `location:"uri" locationName:"ContactFlowId" type:"string" required:"true"` - // The description of the contact flow. + // The description of the flow. Description *string `type:"string"` // The identifier of the Amazon Connect instance. @@ -38961,7 +39454,7 @@ type UpdateContactFlowNameInput struct { // InstanceId is a required field InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` - // The name of the contact flow. + // The name of the flow. Name *string `min:"1" type:"string"` } @@ -39196,8 +39689,8 @@ type UpdateContactScheduleInput struct { InstanceId *string `min:"1" type:"string" required:"true"` // The timestamp, in Unix Epoch seconds format, at which to start running the - // inbound contact flow. The scheduled time cannot be in the past. It must be - // within up to 6 days in future. + // inbound flow. The scheduled time cannot be in the past. It must be within + // up to 6 days in future. // // ScheduledTime is a required field ScheduledTime *time.Time `type:"timestamp" required:"true"` @@ -42695,7 +43188,7 @@ func (s *UserPhoneConfig) SetPhoneType(v string) *UserPhoneConfig { type UserQuickConnectConfig struct { _ struct{} `type:"structure"` - // The identifier of the contact flow. + // The identifier of the flow. // // ContactFlowId is a required field ContactFlowId *string `type:"string" required:"true"` @@ -42918,7 +43411,8 @@ type UserSearchSummary struct { // The identifiers of the user's security profiles. SecurityProfileIds []*string `min:"1" type:"list"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` // The name of the user. @@ -43098,7 +43592,8 @@ type Vocabulary struct { // State is a required field State *string `type:"string" required:"true" enum:"VocabularyState"` - // The tags used to organize, track, or control access for this resource. + // The tags used to organize, track, or control access for this resource. For + // example, { "tags": {"key1":"value1", "key2":"value2"} }. Tags map[string]*string `min:"1" type:"map"` } diff --git a/service/connect/connectiface/interface.go b/service/connect/connectiface/interface.go index b90169bef7..e071ed3de3 100644 --- a/service/connect/connectiface/interface.go +++ b/service/connect/connectiface/interface.go @@ -575,6 +575,13 @@ type ConnectAPI interface { SearchAvailablePhoneNumbersPages(*connect.SearchAvailablePhoneNumbersInput, func(*connect.SearchAvailablePhoneNumbersOutput, bool) bool) error SearchAvailablePhoneNumbersPagesWithContext(aws.Context, *connect.SearchAvailablePhoneNumbersInput, func(*connect.SearchAvailablePhoneNumbersOutput, bool) bool, ...request.Option) error + SearchSecurityProfiles(*connect.SearchSecurityProfilesInput) (*connect.SearchSecurityProfilesOutput, error) + SearchSecurityProfilesWithContext(aws.Context, *connect.SearchSecurityProfilesInput, ...request.Option) (*connect.SearchSecurityProfilesOutput, error) + SearchSecurityProfilesRequest(*connect.SearchSecurityProfilesInput) (*request.Request, *connect.SearchSecurityProfilesOutput) + + SearchSecurityProfilesPages(*connect.SearchSecurityProfilesInput, func(*connect.SearchSecurityProfilesOutput, bool) bool) error + SearchSecurityProfilesPagesWithContext(aws.Context, *connect.SearchSecurityProfilesInput, func(*connect.SearchSecurityProfilesOutput, bool) bool, ...request.Option) error + SearchUsers(*connect.SearchUsersInput) (*connect.SearchUsersOutput, error) SearchUsersWithContext(aws.Context, *connect.SearchUsersInput, ...request.Option) (*connect.SearchUsersOutput, error) SearchUsersRequest(*connect.SearchUsersInput) (*request.Request, *connect.SearchUsersOutput) diff --git a/service/connect/doc.go b/service/connect/doc.go index 5f3137debb..b610c521ee 100644 --- a/service/connect/doc.go +++ b/service/connect/doc.go @@ -20,7 +20,7 @@ // an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints // (https://docs.aws.amazon.com/general/latest/gr/connect_region.html). // -// Working with contact flows? Check out the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). +// Working with flows? Check out the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html). // // See https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08 for more information on this service. // diff --git a/service/connect/errors.go b/service/connect/errors.go index a3e4fc646e..190a88b573 100644 --- a/service/connect/errors.go +++ b/service/connect/errors.go @@ -17,7 +17,7 @@ const ( // ErrCodeContactFlowNotPublishedException for service response error code // "ContactFlowNotPublishedException". // - // The contact flow has not been published. + // The flow has not been published. ErrCodeContactFlowNotPublishedException = "ContactFlowNotPublishedException" // ErrCodeContactNotFoundException for service response error code @@ -53,7 +53,7 @@ const ( // ErrCodeInvalidContactFlowException for service response error code // "InvalidContactFlowException". // - // The contact flow is not valid. + // The flow is not valid. ErrCodeInvalidContactFlowException = "InvalidContactFlowException" // ErrCodeInvalidContactFlowModuleException for service response error code @@ -88,6 +88,8 @@ const ( // ErrCodePropertyValidationException for service response error code // "PropertyValidationException". + // + // The property is not valid. ErrCodePropertyValidationException = "PropertyValidationException" // ErrCodeResourceConflictException for service response error code diff --git a/service/ivschat/api.go b/service/ivschat/api.go index 5632e29df0..3523285a49 100644 --- a/service/ivschat/api.go +++ b/service/ivschat/api.go @@ -1395,7 +1395,10 @@ type CreateRoomInput struct { Name *string `locationName:"name" type:"string"` // Tags to attach to the resource. Array of maps, each of the form string:string - // (key:value). + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented + // there. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -2244,8 +2247,7 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // Tags to attach to the resource. Array of maps, each of the form string:string - // (key:value). + // Tags attached to the resource, from the request. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` @@ -2475,7 +2477,10 @@ type RoomSummary struct { // Room name. The value does not need to be unique. Name *string `locationName:"name" type:"string"` - // Tags attached to the resource. + // Tags attached to the resource. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented + // there. Tags map[string]*string `locationName:"tags" type:"map"` // Time of the room’s last update. This is an ISO 8601 timestamp; note that @@ -2732,7 +2737,10 @@ type TagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` - // Array of tags to be added or updated. + // Array of tags to be added or updated. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented + // there. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` @@ -2889,7 +2897,10 @@ type UntagResourceInput struct { // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` - // Array of tags to be removed. + // Array of tags to be removed. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS Chat has no constraints beyond what is documented + // there. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` diff --git a/service/ivschat/doc.go b/service/ivschat/doc.go index c38ad24286..7de7718c62 100644 --- a/service/ivschat/doc.go +++ b/service/ivschat/doc.go @@ -31,6 +31,24 @@ // connect to and exchange chat messages. See the Room endpoints for more // information. // +// # Tagging +// +// A tag is a metadata label that you assign to an AWS resource. A tag comprises +// a key and a value, both set by you. For example, you might set a tag as topic:nature +// to label a particular video category. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// for more information, including restrictions that apply to tags and "Tag +// naming limits and requirements"; Amazon IVS Chat has no service-specific +// constraints beyond what is documented there. +// +// Tags can help you identify and organize your AWS resources. For example, +// you can use the same tag for different resources to indicate that they are +// related. You can also use tags to manage access (see Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). +// +// The Amazon IVS Chat API has these tag-related endpoints: TagResource, UntagResource, +// and ListTagsForResource. The following resource supports tagging: Room. +// +// At most 50 tags can be applied to a resource. +// // # API Access Security // // Your Amazon IVS Chat applications (service applications and clients) must diff --git a/service/kendra/api.go b/service/kendra/api.go index 93840f6ebe..d37d29aa68 100644 --- a/service/kendra/api.go +++ b/service/kendra/api.go @@ -745,7 +745,8 @@ func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *req // CreateDataSource API operation for AWSKendraFrontendService. // -// Creates a data source that you want to use with an Amazon Kendra index. +// Creates a data source connector that you want to use with an Amazon Kendra +// index. // // You specify a name, data source connector type and description for your data // source. You also specify configuration information for the data source connector. @@ -1433,10 +1434,10 @@ func (c *Kendra) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *req // DeleteDataSource API operation for AWSKendraFrontendService. // -// Deletes an Amazon Kendra data source. An exception is not thrown if the data -// source is already being deleted. While the data source is being deleted, -// the Status field returned by a call to the DescribeDataSource API is set -// to DELETING. For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html). +// Deletes an Amazon Kendra data source connector. An exception is not thrown +// if the data source is already being deleted. While the data source is being +// deleted, the Status field returned by a call to the DescribeDataSource API +// is set to DELETING. For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2172,7 +2173,7 @@ func (c *Kendra) DescribeDataSourceRequest(input *DescribeDataSourceInput) (req // DescribeDataSource API operation for AWSKendraFrontendService. // -// Gets information about an Amazon Kendra data source. +// Gets information about an Amazon Kendra data source connector. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3448,7 +3449,7 @@ func (c *Kendra) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsInpu // ListDataSourceSyncJobs API operation for AWSKendraFrontendService. // -// Gets statistics about synchronizing Amazon Kendra with a data source. +// Gets statistics about synchronizing a data source connector. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3593,7 +3594,7 @@ func (c *Kendra) ListDataSourcesRequest(input *ListDataSourcesInput) (req *reque // ListDataSources API operation for AWSKendraFrontendService. // -// Lists the data sources that you have created. +// Lists the data source connectors that you have created. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5197,8 +5198,9 @@ func (c *Kendra) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobInpu // StartDataSourceSyncJob API operation for AWSKendraFrontendService. // -// Starts a synchronization job for a data source. If a synchronization job -// is already in progress, Amazon Kendra returns a ResourceInUseException exception. +// Starts a synchronization job for a data source connector. If a synchronization +// job is already in progress, Amazon Kendra returns a ResourceInUseException +// exception. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5757,7 +5759,7 @@ func (c *Kendra) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *req // UpdateDataSource API operation for AWSKendraFrontendService. // -// Updates an existing Amazon Kendra data source. +// Updates an existing Amazon Kendra data source connector. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6634,7 +6636,11 @@ type AlfrescoConfiguration struct { SiteUrl *string `min:"1" type:"string" required:"true"` // The path to the SSL certificate stored in an Amazon S3 bucket. You use this - // to connect to Alfresco. + // to connect to Alfresco if you require a secure SSL connection. + // + // You can simply generate a self-signed X509 certificate on any computer using + // OpenSSL. For an example of using OpenSSL to create an X509 certificate, see + // Create and sign an X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). // // SslCertificateS3Path is a required field SslCertificateS3Path *S3Path `type:"structure" required:"true"` @@ -8939,6 +8945,11 @@ type ConfluenceConfiguration struct { // pages. AttachmentConfiguration *ConfluenceAttachmentConfiguration `type:"structure"` + // Whether you want to connect to Confluence using basic authentication of user + // name and password, or a personal access token. You can use a personal access + // token for Confluence Server. + AuthenticationType *string `type:"string" enum:"ConfluenceAuthenticationType"` + // Configuration information for indexing Confluence blogs. BlogConfiguration *ConfluenceBlogConfiguration `type:"structure"` @@ -8982,9 +8993,13 @@ type ConfluenceConfiguration struct { // The Amazon Resource Name (ARN) of an Secrets Manager secret that contains // the user name and password required to connect to the Confluence instance. - // If you use Confluence cloud, you use a generated API token as the password. + // If you use Confluence Cloud, you use a generated API token as the password. // For more information, see Using a Confluence data source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html). // + // You can also provide authentication credentials in the form of a personal + // access token. For more information, see Authentication for a Confluence data + // source (https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html#confluence-authentication). + // // SecretArn is a required field SecretArn *string `min:"1" type:"string" required:"true"` @@ -9087,6 +9102,12 @@ func (s *ConfluenceConfiguration) SetAttachmentConfiguration(v *ConfluenceAttach return s } +// SetAuthenticationType sets the AuthenticationType field's value. +func (s *ConfluenceConfiguration) SetAuthenticationType(v string) *ConfluenceConfiguration { + s.AuthenticationType = &v + return s +} + // SetBlogConfiguration sets the BlogConfiguration field's value. func (s *ConfluenceConfiguration) SetBlogConfiguration(v *ConfluenceBlogConfiguration) *ConfluenceConfiguration { s.BlogConfiguration = v @@ -9933,7 +9954,8 @@ type CreateDataSourceInput struct { Name *string `min:"1" type:"string" required:"true"` // The Amazon Resource Name (ARN) of a role with permission to access the data - // source connector. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // source and required resources. For more information, see IAM roles for Amazon + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). // // You can't specify the RoleArn parameter when the Type parameter is set to // CUSTOM. If you do, you receive a ValidationException exception. @@ -12267,12 +12289,12 @@ func (s DeleteAccessControlConfigurationOutput) GoString() string { type DeleteDataSourceInput struct { _ struct{} `type:"structure"` - // The identifier of the data source you want to delete. + // The identifier of the data source connector you want to delete. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index used with the data source. + // The identifier of the index used with the data source connector. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -13049,12 +13071,12 @@ func (s *DescribeAccessControlConfigurationOutput) SetName(v string) *DescribeAc type DescribeDataSourceInput struct { _ struct{} `type:"structure"` - // The identifier of the data source. + // The identifier of the data source connector. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index used with the data source. + // The identifier of the index used with the data source connector. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -13115,12 +13137,12 @@ func (s *DescribeDataSourceInput) SetIndexId(v string) *DescribeDataSourceInput type DescribeDataSourceOutput struct { _ struct{} `type:"structure"` - // Configuration details for the data source. This shows how the data source - // is configured. The configuration options for a data source depend on the - // data source provider. + // Configuration details for the data source connector. This shows how the data + // source is configured. The configuration options for a data source depend + // on the data source provider. Configuration *DataSourceConfiguration `type:"structure"` - // The Unix timestamp of when the data source was created. + // The Unix timestamp of when the data source connector was created. CreatedAt *time.Time `type:"timestamp"` // Configuration information for altering document metadata and content during @@ -13131,17 +13153,17 @@ type DescribeDataSourceOutput struct { // see Customizing document metadata during the ingestion process (https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). CustomDocumentEnrichmentConfiguration *CustomDocumentEnrichmentConfiguration `type:"structure"` - // The description for the data source. + // The description for the data source connector. Description *string `type:"string"` // When the Status field value is FAILED, the ErrorMessage field contains a // description of the error that caused the data source to fail. ErrorMessage *string `min:"1" type:"string"` - // The identifier of the data source. + // The identifier of the data source connector. Id *string `min:"1" type:"string"` - // The identifier of the index that contains the data source. + // The identifier of the index used with the data source connector. IndexId *string `min:"36" type:"string"` // The code for a language. This shows a supported language for all documents @@ -13150,25 +13172,25 @@ type DescribeDataSourceOutput struct { // other than English (https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). LanguageCode *string `min:"2" type:"string"` - // The name for the data source. + // The name for the data source connector. Name *string `min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the role that enables the data source to - // access its resources. + // The Amazon Resource Name (ARN) of the role with permission to access the + // data source and required resources. RoleArn *string `type:"string"` // The schedule for Amazon Kendra to update the index. Schedule *string `type:"string"` - // The current status of the data source. When the status is ACTIVE the data - // source is ready to use. When the status is FAILED, the ErrorMessage field - // contains the reason that the data source failed. + // The current status of the data source connector. When the status is ACTIVE + // the data source is ready to use. When the status is FAILED, the ErrorMessage + // field contains the reason that the data source failed. Status *string `type:"string" enum:"DataSourceStatus"` - // The type of the data source. + // The type of the data source. For example, SHAREPOINT. Type *string `type:"string" enum:"DataSourceType"` - // The Unix timestamp of when the data source was last updated. + // The Unix timestamp of when the data source connector was last updated. UpdatedAt *time.Time `type:"timestamp"` // Configuration information for an Amazon Virtual Private Cloud to connect @@ -19088,12 +19110,12 @@ func (s *ListAccessControlConfigurationsOutput) SetNextToken(v string) *ListAcce type ListDataSourceSyncJobsInput struct { _ struct{} `type:"structure"` - // The identifier of the data source. + // The identifier of the data source connector. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index used with the data source. + // The identifier of the index used with the data source connector. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -19112,8 +19134,8 @@ type ListDataSourceSyncJobsInput struct { // to jobs between the specified dates. StartTimeFilter *TimeRange `type:"structure"` - // When specified, only returns synchronization jobs with the Status field equal - // to the specified status. + // Only returns synchronization jobs with the Status field equal to the specified + // status. StatusFilter *string `type:"string" enum:"DataSourceSyncJobStatus"` } @@ -19202,7 +19224,7 @@ func (s *ListDataSourceSyncJobsInput) SetStatusFilter(v string) *ListDataSourceS type ListDataSourceSyncJobsOutput struct { _ struct{} `type:"structure"` - // A history of synchronization jobs for the data source. + // A history of synchronization jobs for the data source connector. History []*DataSourceSyncJob `type:"list"` // If the response is truncated, Amazon Kendra returns this token that you can @@ -19243,17 +19265,17 @@ func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyn type ListDataSourcesInput struct { _ struct{} `type:"structure"` - // The identifier of the index used with one or more data sources. + // The identifier of the index used with one or more data source connectors. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` - // The maximum number of data sources to return. + // The maximum number of data source connectors to return. MaxResults *int64 `min:"1" type:"integer"` // If the previous response was incomplete (because there is more data to retrieve), // Amazon Kendra returns a pagination token in the response. You can use this - // pagination token to retrieve the next set of data sources (DataSourceSummaryItems). + // pagination token to retrieve the next set of data source connectors (DataSourceSummaryItems). NextToken *string `min:"1" type:"string"` } @@ -19319,10 +19341,10 @@ type ListDataSourcesOutput struct { _ struct{} `type:"structure"` // If the response is truncated, Amazon Kendra returns this token that you can - // use in the subsequent request to retrieve the next set of data sources. + // use in the subsequent request to retrieve the next set of data source connectors. NextToken *string `min:"1" type:"string"` - // An array of summary information for one or more data sources. + // An array of summary information for one or more data source connector. SummaryItems []*DataSourceSummary `type:"list"` } @@ -20547,7 +20569,11 @@ type OnPremiseConfiguration struct { OrganizationName *string `min:"1" type:"string" required:"true"` // The path to the SSL certificate stored in an Amazon S3 bucket. You use this - // to connect to GitHub. + // to connect to GitHub if you require a secure SSL connection. + // + // You can simply generate a self-signed X509 certificate on any computer using + // OpenSSL. For an example of using OpenSSL to create an X509 certificate, see + // Create and sign an X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). // // SslCertificateS3Path is a required field SslCertificateS3Path *S3Path `type:"structure" required:"true"` @@ -21813,7 +21839,8 @@ type QuipConfiguration struct { // TRUE to index file comments. CrawlFileComments *bool `type:"boolean"` - // The Quip site domain. + // The Quip site domain. For example, https://quip-company.quipdomain.com/browse. + // The domain in this example is "quipdomain". // // Domain is a required field Domain *string `min:"1" type:"string" required:"true"` @@ -21825,8 +21852,10 @@ type QuipConfiguration struct { // takes precedence, and the file isn't included in the index. ExclusionPatterns []*string `type:"list"` - // The identifiers of the Quip folders you want to index. You can find in your - // browser URL when you access your folder in Quip. For example, https://quip-company.com/zlLuOVNSarTL/folder-name. + // The identifiers of the Quip folders you want to index. You can find the folder + // ID in your browser URL when you access your folder in Quip. For example, + // https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder + // ID in this example is "zlLuOVNSarTL". FolderIds []*string `type:"list"` // A list of regular expression patterns to include certain files in your Quip @@ -24272,10 +24301,14 @@ type SharePointConfiguration struct { SharePointVersion *string `type:"string" required:"true" enum:"SharePointVersion"` // The path to the SSL certificate stored in an Amazon S3 bucket. You use this - // to connect to SharePoint. + // to connect to SharePoint Server if you require a secure SSL connection. + // + // You can simply generate a self-signed X509 certificate on any computer using + // OpenSSL. For an example of using OpenSSL to create an X509 certificate, see + // Create and sign an X509 certificate (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html). SslCertificateS3Path *S3Path `type:"structure"` - // The Microsoft SharePoint site URLs for the documents you want to indext. + // The Microsoft SharePoint site URLs for the documents you want to index. // // Urls is a required field Urls []*string `min:"1" type:"list" required:"true"` @@ -24987,12 +25020,12 @@ func (s *SqlConfiguration) SetQueryIdentifiersEnclosingOption(v string) *SqlConf type StartDataSourceSyncJobInput struct { _ struct{} `type:"structure"` - // The identifier of the data source to synchronize. + // The identifier of the data source connector to synchronize. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index that contains the data source. + // The identifier of the index used with the data source connector. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -25148,12 +25181,13 @@ func (s *Status) SetFailureReason(v string) *Status { type StopDataSourceSyncJobInput struct { _ struct{} `type:"structure"` - // The identifier of the data source for which to stop the synchronization jobs. + // The identifier of the data source connector for which to stop the synchronization + // jobs. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` - // The identifier of the index that contains the data source. + // The identifier of the index used with the data source connector. // // IndexId is a required field IndexId *string `min:"36" type:"string" required:"true"` @@ -26227,7 +26261,7 @@ type UpdateDataSourceInput struct { // A new description for the data source connector. Description *string `type:"string"` - // The identifier of the data source you want to update. + // The identifier of the data source connector you want to update. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` @@ -26248,7 +26282,8 @@ type UpdateDataSourceInput struct { Name *string `min:"1" type:"string"` // The Amazon Resource Name (ARN) of a role with permission to access the data - // source. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). + // source and required resources. For more information, see IAM roles for Amazon + // Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). RoleArn *string `type:"string"` // The sync schedule you want to update for the data source connector. @@ -28110,6 +28145,22 @@ func ConfluenceAttachmentFieldName_Values() []string { } } +const ( + // ConfluenceAuthenticationTypeHttpBasic is a ConfluenceAuthenticationType enum value + ConfluenceAuthenticationTypeHttpBasic = "HTTP_BASIC" + + // ConfluenceAuthenticationTypePat is a ConfluenceAuthenticationType enum value + ConfluenceAuthenticationTypePat = "PAT" +) + +// ConfluenceAuthenticationType_Values returns all elements of the ConfluenceAuthenticationType enum +func ConfluenceAuthenticationType_Values() []string { + return []string{ + ConfluenceAuthenticationTypeHttpBasic, + ConfluenceAuthenticationTypePat, + } +} + const ( // ConfluenceBlogFieldNameAuthor is a ConfluenceBlogFieldName enum value ConfluenceBlogFieldNameAuthor = "AUTHOR" diff --git a/service/lookoutmetrics/api.go b/service/lookoutmetrics/api.go index 312d396fa9..e2acc7cd69 100644 --- a/service/lookoutmetrics/api.go +++ b/service/lookoutmetrics/api.go @@ -1447,6 +1447,101 @@ func (c *LookoutMetrics) GetAnomalyGroupWithContext(ctx aws.Context, input *GetA return out, req.Send() } +const opGetDataQualityMetrics = "GetDataQualityMetrics" + +// GetDataQualityMetricsRequest generates a "aws/request.Request" representing the +// client's request for the GetDataQualityMetrics operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetDataQualityMetrics for more information on using the GetDataQualityMetrics +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetDataQualityMetricsRequest method. +// req, resp := client.GetDataQualityMetricsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetrics +func (c *LookoutMetrics) GetDataQualityMetricsRequest(input *GetDataQualityMetricsInput) (req *request.Request, output *GetDataQualityMetricsOutput) { + op := &request.Operation{ + Name: opGetDataQualityMetrics, + HTTPMethod: "POST", + HTTPPath: "/GetDataQualityMetrics", + } + + if input == nil { + input = &GetDataQualityMetricsInput{} + } + + output = &GetDataQualityMetricsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetDataQualityMetrics API operation for Amazon Lookout for Metrics. +// +// Returns details about the requested data quality metrics. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Metrics's +// API operation GetDataQualityMetrics for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource cannot be found. Check the ARN of the resource and +// try again. +// +// - ValidationException +// The input fails to satisfy the constraints specified by the AWS service. +// Check your input values and try again. +// +// - AccessDeniedException +// You do not have sufficient permissions to perform this action. +// +// - TooManyRequestsException +// The request was denied due to too many requests being submitted at the same +// time. +// +// - InternalServerException +// The request processing has failed because of an unknown error, exception, +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetDataQualityMetrics +func (c *LookoutMetrics) GetDataQualityMetrics(input *GetDataQualityMetricsInput) (*GetDataQualityMetricsOutput, error) { + req, out := c.GetDataQualityMetricsRequest(input) + return out, req.Send() +} + +// GetDataQualityMetricsWithContext is the same as GetDataQualityMetrics with the addition of +// the ability to pass a context and additional request options. +// +// See GetDataQualityMetrics for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutMetrics) GetDataQualityMetricsWithContext(ctx aws.Context, input *GetDataQualityMetricsInput, opts ...request.Option) (*GetDataQualityMetricsOutput, error) { + req, out := c.GetDataQualityMetricsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetFeedback = "GetFeedback" // GetFeedbackRequest generates a "aws/request.Request" representing the @@ -3824,6 +3919,49 @@ func (s *AnomalyDetectorConfigSummary) SetAnomalyDetectorFrequency(v string) *An return s } +// Aggregated details about the data quality metrics collected for the AnomalyDetectorArn +// provided in the GetDataQualityMetrics object. +type AnomalyDetectorDataQualityMetric struct { + _ struct{} `type:"structure"` + + // An array of DataQualityMetricList objects. Each object in the array contains + // information about a data quality metric. + MetricSetDataQualityMetricList []*MetricSetDataQualityMetric `type:"list"` + + // The start time for the data quality metrics collection. + StartTimestamp *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnomalyDetectorDataQualityMetric) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnomalyDetectorDataQualityMetric) GoString() string { + return s.String() +} + +// SetMetricSetDataQualityMetricList sets the MetricSetDataQualityMetricList field's value. +func (s *AnomalyDetectorDataQualityMetric) SetMetricSetDataQualityMetricList(v []*MetricSetDataQualityMetric) *AnomalyDetectorDataQualityMetric { + s.MetricSetDataQualityMetricList = v + return s +} + +// SetStartTimestamp sets the StartTimestamp field's value. +func (s *AnomalyDetectorDataQualityMetric) SetStartTimestamp(v time.Time) *AnomalyDetectorDataQualityMetric { + s.StartTimestamp = &v + return s +} + // Contains information about an an anomaly detector. type AnomalyDetectorSummary struct { _ struct{} `type:"structure"` @@ -5169,7 +5307,7 @@ type CreateMetricSetInput struct { MetricSource *MetricSource `type:"structure" required:"true"` // After an interval ends, the amount of seconds that the detector waits before - // importing data. Offset is only supported for S3 and Redshift datasources. + // importing data. Offset is only supported for S3, Redshift, Athena and datasources. Offset *int64 `type:"integer"` // A list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) @@ -5433,6 +5571,67 @@ func (s *CsvFormatDescriptor) SetQuoteSymbol(v string) *CsvFormatDescriptor { return s } +// An array that describes a data quality metric. Each DataQualityMetric object +// contains the data quality metric name, its value, a description of the metric, +// and the affected column. +type DataQualityMetric struct { + _ struct{} `type:"structure"` + + // A description of the data quality metric. + MetricDescription *string `min:"1" type:"string"` + + // The name of the data quality metric. + MetricType *string `type:"string" enum:"DataQualityMetricType"` + + // The value of the data quality metric. + MetricValue *float64 `type:"double"` + + // The column that is being monitored. + RelatedColumnName *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataQualityMetric) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataQualityMetric) GoString() string { + return s.String() +} + +// SetMetricDescription sets the MetricDescription field's value. +func (s *DataQualityMetric) SetMetricDescription(v string) *DataQualityMetric { + s.MetricDescription = &v + return s +} + +// SetMetricType sets the MetricType field's value. +func (s *DataQualityMetric) SetMetricType(v string) *DataQualityMetric { + s.MetricType = &v + return s +} + +// SetMetricValue sets the MetricValue field's value. +func (s *DataQualityMetric) SetMetricValue(v float64) *DataQualityMetric { + s.MetricValue = &v + return s +} + +// SetRelatedColumnName sets the RelatedColumnName field's value. +func (s *DataQualityMetric) SetRelatedColumnName(v string) *DataQualityMetric { + s.RelatedColumnName = &v + return s +} + type DeactivateAnomalyDetectorInput struct { _ struct{} `type:"structure"` @@ -6071,7 +6270,8 @@ type DescribeMetricSetOutput struct { // Contains information about the dataset's source data. MetricSource *MetricSource `type:"structure"` - // The offset in seconds. Only supported for S3 and Redshift datasources. + // After an interval ends, the amount of seconds that the detector waits before + // importing data. Offset is only supported for S3, Redshift, Athena and datasources. Offset *int64 `type:"integer"` // Contains information about the column used for tracking time in your source @@ -6964,6 +7164,92 @@ func (s *GetAnomalyGroupOutput) SetAnomalyGroup(v *AnomalyGroup) *GetAnomalyGrou return s } +type GetDataQualityMetricsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate. + // + // AnomalyDetectorArn is a required field + AnomalyDetectorArn *string `type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of a specific data quality metric set. + MetricSetArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDataQualityMetricsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDataQualityMetricsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDataQualityMetricsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetDataQualityMetricsInput"} + if s.AnomalyDetectorArn == nil { + invalidParams.Add(request.NewErrParamRequired("AnomalyDetectorArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnomalyDetectorArn sets the AnomalyDetectorArn field's value. +func (s *GetDataQualityMetricsInput) SetAnomalyDetectorArn(v string) *GetDataQualityMetricsInput { + s.AnomalyDetectorArn = &v + return s +} + +// SetMetricSetArn sets the MetricSetArn field's value. +func (s *GetDataQualityMetricsInput) SetMetricSetArn(v string) *GetDataQualityMetricsInput { + s.MetricSetArn = &v + return s +} + +type GetDataQualityMetricsOutput struct { + _ struct{} `type:"structure"` + + // A list of the data quality metrics for the AnomalyDetectorArn that you requested. + AnomalyDetectorDataQualityMetricList []*AnomalyDetectorDataQualityMetric `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDataQualityMetricsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetDataQualityMetricsOutput) GoString() string { + return s.String() +} + +// SetAnomalyDetectorDataQualityMetricList sets the AnomalyDetectorDataQualityMetricList field's value. +func (s *GetDataQualityMetricsOutput) SetAnomalyDetectorDataQualityMetricList(v []*AnomalyDetectorDataQualityMetric) *GetDataQualityMetricsOutput { + s.AnomalyDetectorDataQualityMetricList = v + return s +} + type GetFeedbackInput struct { _ struct{} `type:"structure"` @@ -8409,6 +8695,48 @@ func (s *MetricLevelImpact) SetNumTimeSeries(v int64) *MetricLevelImpact { return s } +// An array of DataQualityMetric objects that describes one or more data quality +// metrics. +type MetricSetDataQualityMetric struct { + _ struct{} `type:"structure"` + + // The array of data quality metrics contained in the data quality metric set. + DataQualityMetricList []*DataQualityMetric `type:"list"` + + // The Amazon Resource Name (ARN) of the data quality metric array. + MetricSetArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MetricSetDataQualityMetric) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MetricSetDataQualityMetric) GoString() string { + return s.String() +} + +// SetDataQualityMetricList sets the DataQualityMetricList field's value. +func (s *MetricSetDataQualityMetric) SetDataQualityMetricList(v []*DataQualityMetric) *MetricSetDataQualityMetric { + s.DataQualityMetricList = v + return s +} + +// SetMetricSetArn sets the MetricSetArn field's value. +func (s *MetricSetDataQualityMetric) SetMetricSetArn(v string) *MetricSetDataQualityMetric { + s.MetricSetArn = &v + return s +} + // Contains information about a dataset. type MetricSetSummary struct { _ struct{} `type:"structure"` @@ -9990,7 +10318,7 @@ type UpdateMetricSetInput struct { MetricSource *MetricSource `type:"structure"` // After an interval ends, the amount of seconds that the detector waits before - // importing data. Offset is only supported for S3 and Redshift datasources. + // importing data. Offset is only supported for S3, Redshift, Athena and datasources. Offset *int64 `type:"integer"` // The timestamp column. @@ -10502,6 +10830,54 @@ func Confidence_Values() []string { } } +const ( + // DataQualityMetricTypeColumnCompleteness is a DataQualityMetricType enum value + DataQualityMetricTypeColumnCompleteness = "COLUMN_COMPLETENESS" + + // DataQualityMetricTypeDimensionUniqueness is a DataQualityMetricType enum value + DataQualityMetricTypeDimensionUniqueness = "DIMENSION_UNIQUENESS" + + // DataQualityMetricTypeTimeSeriesCount is a DataQualityMetricType enum value + DataQualityMetricTypeTimeSeriesCount = "TIME_SERIES_COUNT" + + // DataQualityMetricTypeRowsProcessed is a DataQualityMetricType enum value + DataQualityMetricTypeRowsProcessed = "ROWS_PROCESSED" + + // DataQualityMetricTypeRowsPartialCompliance is a DataQualityMetricType enum value + DataQualityMetricTypeRowsPartialCompliance = "ROWS_PARTIAL_COMPLIANCE" + + // DataQualityMetricTypeInvalidRowsCompliance is a DataQualityMetricType enum value + DataQualityMetricTypeInvalidRowsCompliance = "INVALID_ROWS_COMPLIANCE" + + // DataQualityMetricTypeBacktestTrainingDataStartTimeStamp is a DataQualityMetricType enum value + DataQualityMetricTypeBacktestTrainingDataStartTimeStamp = "BACKTEST_TRAINING_DATA_START_TIME_STAMP" + + // DataQualityMetricTypeBacktestTrainingDataEndTimeStamp is a DataQualityMetricType enum value + DataQualityMetricTypeBacktestTrainingDataEndTimeStamp = "BACKTEST_TRAINING_DATA_END_TIME_STAMP" + + // DataQualityMetricTypeBacktestInferenceDataStartTimeStamp is a DataQualityMetricType enum value + DataQualityMetricTypeBacktestInferenceDataStartTimeStamp = "BACKTEST_INFERENCE_DATA_START_TIME_STAMP" + + // DataQualityMetricTypeBacktestInferenceDataEndTimeStamp is a DataQualityMetricType enum value + DataQualityMetricTypeBacktestInferenceDataEndTimeStamp = "BACKTEST_INFERENCE_DATA_END_TIME_STAMP" +) + +// DataQualityMetricType_Values returns all elements of the DataQualityMetricType enum +func DataQualityMetricType_Values() []string { + return []string{ + DataQualityMetricTypeColumnCompleteness, + DataQualityMetricTypeDimensionUniqueness, + DataQualityMetricTypeTimeSeriesCount, + DataQualityMetricTypeRowsProcessed, + DataQualityMetricTypeRowsPartialCompliance, + DataQualityMetricTypeInvalidRowsCompliance, + DataQualityMetricTypeBacktestTrainingDataStartTimeStamp, + DataQualityMetricTypeBacktestTrainingDataEndTimeStamp, + DataQualityMetricTypeBacktestInferenceDataStartTimeStamp, + DataQualityMetricTypeBacktestInferenceDataEndTimeStamp, + } +} + const ( // FrequencyP1d is a Frequency enum value FrequencyP1d = "P1D" diff --git a/service/lookoutmetrics/lookoutmetricsiface/interface.go b/service/lookoutmetrics/lookoutmetricsiface/interface.go index ce8d6e9501..865352d53e 100644 --- a/service/lookoutmetrics/lookoutmetricsiface/interface.go +++ b/service/lookoutmetrics/lookoutmetricsiface/interface.go @@ -119,6 +119,10 @@ type LookoutMetricsAPI interface { GetAnomalyGroupWithContext(aws.Context, *lookoutmetrics.GetAnomalyGroupInput, ...request.Option) (*lookoutmetrics.GetAnomalyGroupOutput, error) GetAnomalyGroupRequest(*lookoutmetrics.GetAnomalyGroupInput) (*request.Request, *lookoutmetrics.GetAnomalyGroupOutput) + GetDataQualityMetrics(*lookoutmetrics.GetDataQualityMetricsInput) (*lookoutmetrics.GetDataQualityMetricsOutput, error) + GetDataQualityMetricsWithContext(aws.Context, *lookoutmetrics.GetDataQualityMetricsInput, ...request.Option) (*lookoutmetrics.GetDataQualityMetricsOutput, error) + GetDataQualityMetricsRequest(*lookoutmetrics.GetDataQualityMetricsInput) (*request.Request, *lookoutmetrics.GetDataQualityMetricsOutput) + GetFeedback(*lookoutmetrics.GetFeedbackInput) (*lookoutmetrics.GetFeedbackOutput, error) GetFeedbackWithContext(aws.Context, *lookoutmetrics.GetFeedbackInput, ...request.Option) (*lookoutmetrics.GetFeedbackOutput, error) GetFeedbackRequest(*lookoutmetrics.GetFeedbackInput) (*request.Request, *lookoutmetrics.GetFeedbackOutput)