The Amazon Resource Name (ARN) of the backup.
" + } + }, "BackupState": { "target": "com.amazonaws.cloudhsmv2#BackupState", "traits": { @@ -102,7 +108,7 @@ "HsmType": { "target": "com.amazonaws.cloudhsmv2#HsmType", "traits": { - "smithy.api#documentation": "The HSM type of the cluster that was backed up.
" + "smithy.api#documentation": "The HSM type used to create the backup.
" } }, "Mode": { @@ -113,7 +119,13 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about a backup of an AWS CloudHSM cluster. All backup objects\n contain the BackupId, BackupState, ClusterId, and\n CreateTimestamp parameters. Backups that were copied into a destination region\n additionally contain the CopyTimestamp, SourceBackup,\n SourceCluster, and SourceRegion parameters. A backup that is\n pending deletion will include the DeleteTimestamp parameter.
Contains information about a backup of an CloudHSM cluster. All backup objects\n contain the BackupId, BackupState, ClusterId, and\n CreateTimestamp parameters. Backups that were copied into a destination region\n additionally contain the CopyTimestamp, SourceBackup,\n SourceCluster, and SourceRegion parameters. A backup that is\n pending deletion will include the DeleteTimestamp parameter.
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS\n CloudHSM User Guide.
", + "smithy.api#documentation": "For more information about CloudHSM, see CloudHSM and the \n CloudHSM User Guide.
", "smithy.api#title": "AWS CloudHSM V2", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1267,7 +1288,7 @@ "AwsHardwareCertificate": { "target": "com.amazonaws.cloudhsmv2#Cert", "traits": { - "smithy.api#documentation": "The HSM hardware certificate issued (signed) by AWS CloudHSM.
" + "smithy.api#documentation": "The HSM hardware certificate issued (signed) by CloudHSM.
" } }, "ManufacturerHardwareCertificate": { @@ -1299,6 +1320,12 @@ "smithy.api#error": "client" } }, + "com.amazonaws.cloudhsmv2#CloudHsmArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-(us-gov))?:cloudhsm:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]{1}):[0-9]{12}:(backup/backup|cluster/cluster|hsm/hsm)-[2-7a-zA-Z]{11,16}$" + } + }, "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException": { "type": "structure", "members": { @@ -1307,7 +1334,7 @@ } }, "traits": { - "smithy.api#documentation": "The request was rejected because of an AWS CloudHSM internal failure. The request can\n be retried.
", + "smithy.api#documentation": "The request was rejected because of an CloudHSM internal failure. The request can\n be retried.
", "smithy.api#error": "server" } }, @@ -1460,7 +1487,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about an AWS CloudHSM cluster.
" + "smithy.api#documentation": "Contains information about an CloudHSM cluster.
" } }, "com.amazonaws.cloudhsmv2#ClusterId": { @@ -1589,7 +1616,7 @@ } ], "traits": { - "smithy.api#documentation": "Copy an AWS CloudHSM cluster backup to a different region.
" + "smithy.api#documentation": "Copy an CloudHSM cluster backup to a different region.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#CopyBackupToRegionRequest": { @@ -1663,7 +1690,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new AWS CloudHSM cluster.
" + "smithy.api#documentation": "Creates a new CloudHSM cluster.
\n\n Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup \n ARN in the value of the SourceBackupId parameter.
" } }, "com.amazonaws.cloudhsmv2#CreateClusterRequest": { @@ -1683,9 +1710,9 @@ } }, "SourceBackupId": { - "target": "com.amazonaws.cloudhsmv2#BackupId", + "target": "com.amazonaws.cloudhsmv2#BackupArn", "traits": { - "smithy.api#documentation": "The identifier (ID) of the cluster backup to restore. Use this value to restore the\n cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.
" + "smithy.api#documentation": "The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the\n cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.\n
" } }, "SubnetIds": { @@ -1752,7 +1779,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new hardware security module (HSM) in the specified AWS CloudHSM\n cluster.
" + "smithy.api#documentation": "Creates a new hardware security module (HSM) in the specified CloudHSM\n cluster.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.
" } }, "com.amazonaws.cloudhsmv2#CreateHsmRequest": { @@ -1823,7 +1850,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days\n after the DeleteBackup request is made. For more information on restoring a backup, see\n RestoreBackup.
" + "smithy.api#documentation": "Deletes a specified CloudHSM backup. A backup can be restored up to 7 days\n after the DeleteBackup request is made. For more information on restoring a backup, see\n RestoreBackup.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#DeleteBackupRequest": { @@ -1884,7 +1911,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must\n delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
" + "smithy.api#documentation": "Deletes the specified CloudHSM cluster. Before you can delete a cluster, you must\n delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#DeleteClusterRequest": { @@ -1942,7 +1969,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP\n address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to\n specify only one of these values. To find these values, use DescribeClusters.
" + "smithy.api#documentation": "Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP\n address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to\n specify only one of these values. To find these values, use DescribeClusters.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#DeleteHsmRequest": { @@ -1992,6 +2019,69 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudhsmv2#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudhsmv2#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudhsmv2#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from\n any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that \n backup.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" + } + }, + "com.amazonaws.cloudhsmv2#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource from which the policy will be removed.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudhsmv2#DeleteResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource from which the policy was deleted.
" + } + }, + "Policy": { + "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The policy previously attached to the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudhsmv2#DescribeBackups": { "type": "operation", "input": { @@ -2021,7 +2111,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about backups of AWS CloudHSM clusters.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the backups. When the response contains only a subset of backups, it includes a\n NextToken value. Use this value in a subsequent DescribeBackups\n request to get more backups. When you receive a response with no NextToken (or an\n empty or null value), that means there are no more backups to get.
Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the backups. When the response contains only a subset of backups, it includes a\n NextToken value. Use this value in a subsequent DescribeBackups\n request to get more backups. When you receive a response with no NextToken (or an\n empty or null value), that means there are no more backups to get.
\n Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2050,6 +2140,12 @@ "smithy.api#documentation": "One or more filters to limit the items returned in the response.
\nUse the backupIds filter to return only the specified backups. Specify\n backups by their backup identifier (ID).
Use the sourceBackupIds filter to return only the backups created from a\n source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.
Use the clusterIds filter to return only the backups for the specified\n clusters. Specify clusters by their cluster identifier (ID).
Use the states filter to return only backups that match the specified\n state.
Use the neverExpires filter to return backups filtered by the value in the\n neverExpires parameter. True returns all backups exempt from the\n backup retention policy. False returns all backups with a backup retention policy\n defined at the cluster.
Describe backups that are shared with you.
\nBy default when using this option, the command returns backups that have been shared using a standard Resource Access Manager \n resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a \n standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation.\n\n For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.
\nGets information about AWS CloudHSM clusters.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the clusters. When the response contains only a subset of clusters, it includes\n a NextToken value. Use this value in a subsequent DescribeClusters\n request to get more clusters. When you receive a response with no NextToken (or\n an empty or null value), that means there are no more clusters to get.
Gets information about CloudHSM clusters.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the clusters. When the response contains only a subset of clusters, it includes\n a NextToken value. Use this value in a subsequent DescribeClusters\n request to get more clusters. When you receive a response with no NextToken (or\n an empty or null value), that means there are no more clusters to get.
\n Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2235,6 +2331,63 @@ } } }, + "com.amazonaws.cloudhsmv2#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudhsmv2#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudhsmv2#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the resource policy document attached to a given resource.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" + } + }, + "com.amazonaws.cloudhsmv2#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource to which a policy is attached.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudhsmv2#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The policy attached to a resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudhsmv2#Hsm": { "type": "structure", "members": { @@ -2289,7 +2442,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about a hardware security module (HSM) in an AWS CloudHSM\n cluster.
" + "smithy.api#documentation": "Contains information about a hardware security module (HSM) in an CloudHSM\n cluster.
" } }, "com.amazonaws.cloudhsmv2#HsmId": { @@ -2375,7 +2528,7 @@ } ], "traits": { - "smithy.api#documentation": "Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your\n issuing certificate authority (CA) and the CA's root certificate. Before you can claim a\n cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA.\n To get the cluster's CSR, use DescribeClusters.
" + "smithy.api#documentation": "Claims an CloudHSM cluster by submitting the cluster certificate issued by your\n issuing certificate authority (CA) and the CA's root certificate. Before you can claim a\n cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA.\n To get the cluster's CSR, use DescribeClusters.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#InitializeClusterRequest": { @@ -2462,7 +2615,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of tags for the specified AWS CloudHSM cluster.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the tags. When the response contains only a subset of tags, it includes a\n NextToken value. Use this value in a subsequent ListTags request to\n get more tags. When you receive a response with no NextToken (or an empty or null\n value), that means there are no more tags to get.
Gets a list of tags for the specified CloudHSM cluster.
\nThis is a paginated operation, which means that each response might contain only a\n subset of all the tags. When the response contains only a subset of tags, it includes a\n NextToken value. Use this value in a subsequent ListTags request to\n get more tags. When you receive a response with no NextToken (or an empty or null\n value), that means there are no more tags to get.
\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2553,7 +2706,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies attributes for AWS CloudHSM backup.
" + "smithy.api#documentation": "Modifies attributes for CloudHSM backup.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#ModifyBackupAttributesRequest": { @@ -2615,7 +2768,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies AWS CloudHSM cluster.
" + "smithy.api#documentation": "Modifies CloudHSM cluster.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#ModifyClusterRequest": { @@ -2670,6 +2823,75 @@ } } }, + "com.amazonaws.cloudhsmv2#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudhsmv2#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudhsmv2#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmAccessDeniedException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmInternalFailureException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmInvalidRequestException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudhsmv2#CloudHsmServiceException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity \n (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support \n CloudHSM resource policies:
\nBackup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.
\nIn order to share a backup, it must be in a 'READY' state and you must own it.
\nWhile you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager\n (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at\n one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to\n describe the backups you share with them, you must promote the backup to a standard RAM\n Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.\n\n For more information, see Working with shared backups in the CloudHSM User Guide
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" + } + }, + "com.amazonaws.cloudhsmv2#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
" + } + }, + "Policy": { + "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The policy you want to associate with a resource.
\nFor an example policy, see Working with shared backups in the CloudHSM User Guide
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudhsmv2#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.cloudhsmv2#CloudHsmArn", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource to which a policy is attached.
" + } + }, + "Policy": { + "target": "com.amazonaws.cloudhsmv2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "The policy attached to a resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudhsmv2#Region": { "type": "string", "traits": { @@ -2682,6 +2904,15 @@ "smithy.api#pattern": "^(?:cluster|backup)-[2-7a-zA-Z]{11,16}$" } }, + "com.amazonaws.cloudhsmv2#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + } + } + }, "com.amazonaws.cloudhsmv2#RestoreBackup": { "type": "operation", "input": { @@ -2708,7 +2939,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores a specified AWS CloudHSM backup that is in the\n PENDING_DELETION state. For mor information on deleting a backup, see\n DeleteBackup.
Restores a specified CloudHSM backup that is in the\n PENDING_DELETION state. For more information on deleting a backup, see\n DeleteBackup.
\n Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#RestoreBackupRequest": { @@ -2868,7 +3099,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
" + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified CloudHSM cluster.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#TagResourceRequest": { @@ -2942,7 +3173,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified tag or tags from the specified AWS CloudHSM cluster.
" + "smithy.api#documentation": "Removes the specified tag or tags from the specified CloudHSM cluster.
\n\n Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" } }, "com.amazonaws.cloudhsmv2#UntagResourceRequest": { diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 415c13eeafd..7a735258203 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -378,6 +378,21 @@ "smithy.api#documentation": "A structure that defines search criteria for contacts using agent hierarchy group levels.\n For more information about agent hierarchies, see Set Up Agent Hierarchies in the\n Amazon Connect Administrator Guide.
" } }, + "com.amazonaws.connect#AgentId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connect#AgentIds": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentId" + } + }, "com.amazonaws.connect#AgentInfo": { "type": "structure", "members": { @@ -707,6 +722,20 @@ } } }, + "com.amazonaws.connect#AgentsCriteria": { + "type": "structure", + "members": { + "AgentIds": { + "target": "com.amazonaws.connect#AgentIds", + "traits": { + "smithy.api#documentation": "An object to specify a list of agents, by Agent ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Can be used to define a list of preferred agents to target the contact within the queue.\n Note that agents must have the queue in their routing profile in order to be offered the\n contact.
" + } + }, "com.amazonaws.connect#AgentsMinOneMaxHundred": { "type": "list", "member": { @@ -3834,11 +3863,17 @@ } }, "ProficiencyLevel": { - "target": "com.amazonaws.connect#ProficiencyLevel", + "target": "com.amazonaws.connect#NullableProficiencyLevel", "traits": { "smithy.api#documentation": "The proficiency level of the condition.
" } }, + "MatchCriteria": { + "target": "com.amazonaws.connect#MatchCriteria", + "traits": { + "smithy.api#documentation": "An object to define AgentsCriteria.
List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
\nValid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer\n
List of potential issues causing degradation of quality on a media connection. If the\n service did not detect any potential quality issues the list is empty.
\nValid values: HighPacketLoss | HighRoundTripTime |\n HighJitterBuffer\n
Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
" + "smithy.api#documentation": "Indicates how an outbound campaign call is\n actually disposed if the contact is connected to Amazon Connect.
" } }, "CustomerVoiceActivity": { @@ -5176,7 +5211,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes and can be accessed in\n flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used\n to show channel subtype. For example, connect:Guide or\n connect:SMS.
Timestamp that measures the beginning of the customer greeting from an outbound voice call.
" + "smithy.api#documentation": "Timestamp that measures the beginning of the customer greeting from an outbound voice\n call.
" } }, "GreetingEndTimestamp": { @@ -13518,7 +13553,7 @@ "PotentialDisconnectIssue": { "target": "com.amazonaws.connect#PotentialDisconnectIssue", "traits": { - "smithy.api#documentation": "Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
" + "smithy.api#documentation": "Indicates the potential disconnection issues for a call. This field is not populated if the\n service does not detect potential issues.
" } } }, @@ -15452,7 +15487,7 @@ "DoubleValue": { "target": "com.amazonaws.connect#Double", "traits": { - "smithy.api#documentation": "a Double number value type.
" + "smithy.api#documentation": "A Double number value type.
" } }, "EmptyValue": { @@ -16517,7 +16552,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Average flow time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nMetric filter:
\nValid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows outcome\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp
\nUI name: Flows started\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Maximum flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued time\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Minimum flow time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Percent
\nValid metric filter key: FLOWS_OUTCOME_TYPE\n
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows outcome percentage.
\nThe FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback attempts\n
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Average flow time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: This metric is not available in Amazon Connect admin website.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows outcome\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp
\nUI name: Flows started\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Maximum flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued time\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Minimum flow time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid metric filter key: FLOWS_OUTCOME_TYPE\n
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows outcome percentage.
\nThe FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: Count
\nMetric filter:
\nValid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback attempts\n
\nInformation about the agent hierarchy. Hierarchies can be configured with up to five levels.
" + "smithy.api#documentation": "Information about the agent hierarchy. Hierarchies can be configured with up to five\n levels.
" } }, "com.amazonaws.connect#HierarchyLevel": { @@ -17974,7 +18009,7 @@ } ], "traits": { - "smithy.api#documentation": "Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an\n Amazon Connect instance. You can call this API only in the same Amazon Web Services Region\n where the Amazon Connect instance was created.
", + "smithy.api#documentation": "Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an\n Amazon Connect instance. You can call this API only in the same Amazon Web Services Region\n where the Amazon Connect instance was created.
\nCall the DescribePhoneNumber API\n to verify the status of a previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a\n service quota exception. Otherwise, it is possible you will be blocked from claiming and\n releasing any more numbers until up to 180 days past the oldest number released has expired.
\nBy default you can claim or import and then release up to 200% of your maximum number of\n active phone numbers. If you claim or import and then release phone numbers using the UI or API\n during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you\n will be blocked from claiming or importing any more numbers until 180 days past the oldest number\n released has expired.
\nFor example, if you already have 99 claimed or imported numbers and a service level quota of\n 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you\n will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers\n until you open an Amazon Web Services Support ticket.
", "smithy.api#http": { "method": "POST", "uri": "/phone-number/import", @@ -23302,6 +23337,20 @@ "com.amazonaws.connect#Long": { "type": "long" }, + "com.amazonaws.connect#MatchCriteria": { + "type": "structure", + "members": { + "AgentsCriteria": { + "target": "com.amazonaws.connect#AgentsCriteria", + "traits": { + "smithy.api#documentation": "An object to define AgentIds.
An object to define AgentsCriteria.
The type of notification recipient.
" } }, + "com.amazonaws.connect#NullableProficiencyLevel": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 1.0, + "max": 5.0 + } + } + }, "com.amazonaws.connect#NumberReference": { "type": "structure", "members": { @@ -28766,13 +28824,13 @@ "Steps": { "target": "com.amazonaws.connect#Steps", "traits": { - "smithy.api#documentation": "List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
" + "smithy.api#documentation": "List of routing steps. When Amazon Connect does not find an available agent meeting the\n requirements in a step for a given step duration, the routing criteria will move on to the next\n step sequentially until a join is completed with an agent. When all steps are exhausted, the\n contact will be offered to any agent in the queue.
" } }, "ActivationTimestamp": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
" + "smithy.api#documentation": "The timestamp indicating when the routing criteria is set to active. A routing criteria is\n activated when contact is transferred to a queue. ActivationTimestamp will be set on routing\n criteria for contacts in agent queue even though Routing criteria is never activated for contacts\n in agent queue.
" } }, "Index": { @@ -29133,7 +29191,7 @@ "StringCondition": { "target": "com.amazonaws.connect#StringCondition", "traits": { - "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are\n associatedQueueIds, name, description, and resourceID.
A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are\n associatedQueueIds, name, description, and\n resourceID.
The search criteria based on user-defined contact attributes that have been configured for\n contact search. For more information, see Search by customer contact\n attributes in the Amazon Connect Administrator Guide.
\nTo use SearchableContactAttributes in a search request, the\n GetContactAttributes action is required to perform an API request. For more\n information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
The search criteria based on user-defined contact attributes that have been configured for\n contact search. For more information, see Search by custom contact\n attributes in the Amazon Connect Administrator Guide.
\nTo use SearchableContactAttributes in a search request, the\n GetContactAttributes action is required to perform an API request. For more\n information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
A structure that defineds the field name to sort by and a sort order.
" + "smithy.api#documentation": "A structure that defines the field name to sort by and a sort order.
" } }, "com.amazonaws.connect#SortOrder": { @@ -32147,7 +32205,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
\nWhen a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
\nA 429 error occurs in the following situations:
\nAPI rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.
The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect\n Administrator Guide.
", + "smithy.api#documentation": "Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
\nWhen a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
\nA 429 error occurs in the following situations:
\nAPI rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.
The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect\n Administrator Guide:
\n\n Concepts: Web and mobile messaging capabilities in Amazon Connect\n
\nInitiates real-time message streaming for a new chat contact.
\nFor more information about message streaming, see Enable real-time chat message\n streaming in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Initiates real-time message streaming for a new chat contact.
\nFor more information about message streaming, see Enable real-time chat message\n streaming in the Amazon Connect Administrator Guide.
\nFor more information about chat, see the following topics in the Amazon Connect\n Administrator Guide:
\n\n Concepts: Web and mobile messaging capabilities in Amazon Connect\n
\nThe custom AMI ID to use for the instance type.
" } + }, + "Priority": { + "target": "com.amazonaws.emr#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. \n Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
" + } } }, "traits": { @@ -5777,6 +5783,12 @@ "traits": { "smithy.api#documentation": "The custom AMI ID to use for the instance type.
" } + }, + "Priority": { + "target": "com.amazonaws.emr#NonNegativeDouble", + "traits": { + "smithy.api#documentation": "The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. \n Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
" + } } }, "traits": { @@ -7807,6 +7819,12 @@ "traits": { "smithy.api#enumValue": "lowest-price" } + }, + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prioritized" + } } } }, @@ -7817,7 +7835,7 @@ "target": "com.amazonaws.emr#OnDemandProvisioningAllocationStrategy", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the strategy to use in launching On-Demand instance fleets. Currently, the\n only option is lowest-price (the default), which launches the lowest price\n first.
Specifies the strategy to use in launching On-Demand instance fleets. Available\n options are lowest-price and prioritized. lowest-price\n specifies to launch the instances with the lowest price first, and prioritized specifies\n that Amazon EMR should launch the instances with the highest priority first. The default is\n lowest-price.
Specifies one of the following strategies to launch Spot Instance fleets: price-capacity-optimized, capacity-optimized, lowest-price, or diversified. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized strategy. You can't change the allocation strategy from the old console.
Specifies one of the following strategies to launch Spot Instance fleets: \n capacity-optimized, price-capacity-optimized, lowest-price, or \n diversified, and capacity-optimized-prioritized. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized strategy. You can't change the allocation strategy from the old console.
The Database object represents a logical grouping of tables that might reside\n in a Hive metastore or an RDBMS.
Allows you to specify that you want to list the databases shared with your account. The allowable values are FEDERATED, FOREIGN or ALL.
If set to FEDERATED, will list the federated databases (referencing an external entity) shared with your account.
If set to FOREIGN, will list the databases shared with your account.
If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.
Specifies the database fields returned by the GetDatabases call. This parameter doesn’t accept an empty list. The request must include the NAME.
Describes the minimum time in milliseconds after a checkpoint operation completes that a\n new checkpoint operation can start. If a checkpoint operation takes longer than the\n CheckpointInterval, the application otherwise performs continual checkpoint\n operations. For more information, see Tuning Checkpointing in the Apache Flink\n Documentation.
If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this \n API or in application code.
Describes the minimum time in milliseconds after a checkpoint operation completes that a\n new checkpoint operation can start. If a checkpoint operation takes longer than the\n CheckpointInterval, the application otherwise performs continual checkpoint\n operations. For more information, see Tuning Checkpointing in the Apache Flink\n Documentation.
If CheckpointConfiguration.ConfigurationType is DEFAULT,\n the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this \n API or in application code.
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault \n tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the\n Apache Flink Documentation.
" + "smithy.api#documentation": "Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault \n tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the\n Apache Flink Documentation.
" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointConfigurationDescription": { @@ -3234,7 +3234,7 @@ "CheckpointConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#CheckpointConfiguration", "traits": { - "smithy.api#documentation": "Describes an application's checkpointing configuration. Checkpointing is the \n process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.
" + "smithy.api#documentation": "Describes an application's checkpointing configuration. Checkpointing is the \n process of persisting application state for fault tolerance.\n For more information, see \n \n Checkpoints for Fault Tolerance in the \n Apache Flink Documentation.
" } }, "MonitoringConfiguration": { @@ -3278,7 +3278,7 @@ "JobPlanDescription": { "target": "com.amazonaws.kinesisanalyticsv2#JobPlanDescription", "traits": { - "smithy.api#documentation": "The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink\n Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
" + "smithy.api#documentation": "The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink\n Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
" } } }, @@ -3318,7 +3318,7 @@ "AllowNonRestoredState": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot \n be mapped to the new program.\n This will happen if the program is updated between snapshots to remove stateful parameters, and \n state data in the snapshot no longer \n corresponds to valid application data. For more information, see \n \n Allowing Non-Restored State in the Apache Flink\n documentation.
\nThis value defaults to false. If you update your application without\n specifying this parameter, AllowNonRestoredState will be set to false,\n even if it was previously set to true.
When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot \n be mapped to the new program.\n This will happen if the program is updated between snapshots to remove stateful parameters, and \n state data in the snapshot no longer \n corresponds to valid application data. For more information, see \n \n Allowing Non-Restored State in the Apache Flink\n documentation.
\nThis value defaults to false. If you update your application without\n specifying this parameter, AllowNonRestoredState will be set to false,\n even if it was previously set to true.
Describes parameters for how a Managed Service for Apache Flink application\n executes multiple tasks simultaneously. For more information about parallelism,\n see Parallel Execution in the Apache Flink\n Documentation.
" + "smithy.api#documentation": "Describes parameters for how a Managed Service for Apache Flink application\n executes multiple tasks simultaneously. For more information about parallelism,\n see Parallel Execution in the Apache Flink\n Documentation.
" } }, "com.amazonaws.kinesisanalyticsv2#ParallelismConfigurationDescription": { @@ -6722,6 +6722,12 @@ "traits": { "smithy.api#enumValue": "FLINK-1_18" } + }, + "FLINK_1_19": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLINK-1_19" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index a04daec6154..c20cf2b0975 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -29,51 +29,6 @@ ] }, "shapes": { - "com.amazonaws.opensearch#AIMLOptionsInput": { - "type": "structure", - "members": { - "NaturalLanguageQueryGenerationOptions": { - "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput", - "traits": { - "smithy.api#documentation": "Container for parameters required for natural language query generation on the specified domain.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container for parameters required to enable all machine learning features.
" - } - }, - "com.amazonaws.opensearch#AIMLOptionsOutput": { - "type": "structure", - "members": { - "NaturalLanguageQueryGenerationOptions": { - "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput", - "traits": { - "smithy.api#documentation": "Container for parameters required for natural language query generation on the specified domain.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container for parameters representing the state of machine learning features on the specified domain.
" - } - }, - "com.amazonaws.opensearch#AIMLOptionsStatus": { - "type": "structure", - "members": { - "Options": { - "target": "com.amazonaws.opensearch#AIMLOptionsOutput", - "traits": { - "smithy.api#documentation": "Machine learning options on the specified domain.
" - } - }, - "Status": { - "target": "com.amazonaws.opensearch#OptionStatus" - } - }, - "traits": { - "smithy.api#documentation": "The status of machine learning options on the specified domain.
" - } - }, "com.amazonaws.opensearch#ARN": { "type": "string", "traits": { @@ -3363,12 +3318,6 @@ "traits": { "smithy.api#documentation": "Software update options for the domain.
" } - }, - "AIMLOptions": { - "target": "com.amazonaws.opensearch#AIMLOptionsInput", - "traits": { - "smithy.api#documentation": "Options for all machine learning features for the specified domain.
" - } } }, "traits": { @@ -5761,12 +5710,6 @@ "traits": { "smithy.api#documentation": "Information about the domain properties that are currently being modified.
" } - }, - "AIMLOptions": { - "target": "com.amazonaws.opensearch#AIMLOptionsStatus", - "traits": { - "smithy.api#documentation": "Container for parameters required to enable all machine learning features.
" - } } }, "traits": { @@ -6443,12 +6386,6 @@ "traits": { "smithy.api#documentation": "Information about the domain properties that are currently being modified.
" } - }, - "AIMLOptions": { - "target": "com.amazonaws.opensearch#AIMLOptionsOutput", - "traits": { - "smithy.api#documentation": "Container for parameters required to enable all machine learning features.
" - } } }, "traits": { @@ -9099,104 +9036,6 @@ "target": "com.amazonaws.opensearch#ModifyingProperties" } }, - "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState": { - "type": "enum", - "members": { - "NotEnabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_ENABLED" - } - }, - "EnableComplete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLE_COMPLETE" - } - }, - "EnableInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLE_IN_PROGRESS" - } - }, - "EnableFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLE_FAILED" - } - }, - "DisableComplete": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_COMPLETE" - } - }, - "DisableInProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_IN_PROGRESS" - } - }, - "DisableFailed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_FAILED" - } - } - } - }, - "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState": { - "type": "enum", - "members": { - "Enabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "Disabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput": { - "type": "structure", - "members": { - "DesiredState": { - "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", - "traits": { - "smithy.api#documentation": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container for parameters required to enable the natural language query generation feature.
" - } - }, - "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput": { - "type": "structure", - "members": { - "DesiredState": { - "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", - "traits": { - "smithy.api#documentation": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" - } - }, - "CurrentState": { - "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState", - "traits": { - "smithy.api#documentation": "The current state of the natural language query generation feature, indicating completion, in progress, or failure.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Container for parameters representing the state of the natural language query generation feature on the specified domain.
" - } - }, "com.amazonaws.opensearch#NextToken": { "type": "string", "traits": { @@ -12382,12 +12221,6 @@ "traits": { "smithy.api#documentation": "Service software update options for the domain.
" } - }, - "AIMLOptions": { - "target": "com.amazonaws.opensearch#AIMLOptionsInput", - "traits": { - "smithy.api#documentation": "Options for all machine learning features for the specified domain.
" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/pi.json b/codegen/sdk-codegen/aws-models/pi.json index 1cd963a0464..fc5fe125bc4 100644 --- a/codegen/sdk-codegen/aws-models/pi.json +++ b/codegen/sdk-codegen/aws-models/pi.json @@ -523,7 +523,7 @@ "Filter": { "target": "com.amazonaws.pi#MetricQueryFilterMap", "traits": { - "smithy.api#documentation": "One or more filters to apply in the request. Restrictions:
\nAny number of filters by the same dimension, as specified in the GroupBy or\n Partition parameters.
A single filter for any other dimension in this dimension group.
\nOne or more filters to apply in the request. Restrictions:
\nAny number of filters by the same dimension, as specified in the GroupBy or\n Partition parameters.
A single filter for any other dimension in this dimension group.
\nThe db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
One or more filters to apply in the request. Restrictions:
\nAny number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.
\nOne or more filters to apply in the request. Restrictions:
\nAny number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.
\nThe db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
The persistent application settings for users of a WorkSpaces pool.
" + "smithy.api#documentation": "The persistent application settings for WorkSpaces Pools users.
" } }, "com.amazonaws.workspaces#ApplicationSettingsResponse": { @@ -489,7 +489,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the persistent application settings for users of a WorkSpaces pool.
" + "smithy.api#documentation": "Describes the persistent application settings for WorkSpaces Pools users.
" } }, "com.amazonaws.workspaces#ApplicationSettingsStatusEnum": { @@ -1082,7 +1082,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the user capacity for a WorkSpaces pool.
" + "smithy.api#documentation": "Describes the user capacity for a pool of WorkSpaces.
" } }, "com.amazonaws.workspaces#CapacityStatus": { @@ -1105,7 +1105,7 @@ "ActualUserSessions": { "target": "com.amazonaws.workspaces#ActualUserSessions", "traits": { - "smithy.api#documentation": "The total number of session slots that are available for WorkSpaces pools.
", + "smithy.api#documentation": "The total number of session slots that are available for a pool of WorkSpaces.
", "smithy.api#required": {} } }, @@ -1118,7 +1118,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the capacity status for a WorkSpaces pool
" + "smithy.api#documentation": "Describes the capacity status for a pool of WorkSpaces.
" } }, "com.amazonaws.workspaces#CertificateAuthorityArn": { @@ -2519,54 +2519,54 @@ "PoolName": { "target": "com.amazonaws.workspaces#WorkspacesPoolName", "traits": { - "smithy.api#documentation": "The name of the WorkSpaces pool.
", + "smithy.api#documentation": "The name of the pool.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.workspaces#UpdateDescription", "traits": { - "smithy.api#documentation": "The WorkSpaces pool description.
", + "smithy.api#documentation": "The pool description.
", "smithy.api#required": {} } }, "BundleId": { "target": "com.amazonaws.workspaces#BundleId", "traits": { - "smithy.api#documentation": "The identifier of the bundle for the WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of the bundle for the pool.
", "smithy.api#required": {} } }, "DirectoryId": { "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "The identifier of the directory for the WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of the directory for the pool.
", "smithy.api#required": {} } }, "Capacity": { "target": "com.amazonaws.workspaces#Capacity", "traits": { - "smithy.api#documentation": "The user capacity of the WorkSpaces pool.
", + "smithy.api#documentation": "The user capacity of the pool.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.workspaces#TagList", "traits": { - "smithy.api#documentation": "The tags for the WorkSpaces pool.
" + "smithy.api#documentation": "The tags for the pool.
" } }, "ApplicationSettings": { "target": "com.amazonaws.workspaces#ApplicationSettingsRequest", "traits": { - "smithy.api#documentation": "Indicates the application settings of the WorkSpaces pool.
" + "smithy.api#documentation": "Indicates the application settings of the pool.
" } }, "TimeoutSettings": { "target": "com.amazonaws.workspaces#TimeoutSettings", "traits": { - "smithy.api#documentation": "Indicates the timeout settings of the WorkSpaces pool.
" + "smithy.api#documentation": "Indicates the timeout settings of the pool.
" } } }, @@ -2580,7 +2580,7 @@ "WorkspacesPool": { "target": "com.amazonaws.workspaces#WorkspacesPool", "traits": { - "smithy.api#documentation": "Indicates the WorkSpaces pool to create.
" + "smithy.api#documentation": "Indicates the pool to create.
" } } }, @@ -4838,7 +4838,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a list that describes the streaming sessions for a specified WorkSpaces pool.
" + "smithy.api#documentation": "Retrieves a list that describes the streaming sessions for a specified pool.
" } }, "com.amazonaws.workspaces#DescribeWorkspacesPoolSessionsRequest": { @@ -4847,7 +4847,7 @@ "PoolId": { "target": "com.amazonaws.workspaces#WorkspacesPoolId", "traits": { - "smithy.api#documentation": "The identifier of the WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of the pool.
", "smithy.api#required": {} } }, @@ -4880,7 +4880,7 @@ "Sessions": { "target": "com.amazonaws.workspaces#WorkspacesPoolSessions", "traits": { - "smithy.api#documentation": "Describes the WorkSpaces pool sessions.
" + "smithy.api#documentation": "Describes the pool sessions.
" } }, "NextToken": { @@ -4914,7 +4914,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified WorkSpaces pool.
" + "smithy.api#documentation": "Describes the specified WorkSpaces Pools.
" } }, "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilter": { @@ -4930,20 +4930,20 @@ "Values": { "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterValues", "traits": { - "smithy.api#documentation": "The values for filtering WorkSpaces pools.
", + "smithy.api#documentation": "The values for filtering WorkSpaces Pools.
", "smithy.api#required": {} } }, "Operator": { "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterOperator", "traits": { - "smithy.api#documentation": "The operator values for filtering WorkSpaces pools.
", + "smithy.api#documentation": "The operator values for filtering WorkSpaces Pools.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes the filter conditions for the WorkSpaces pool to return.
" + "smithy.api#documentation": "Describes the filter conditions for WorkSpaces Pools to return.
" } }, "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterName": { @@ -5026,13 +5026,13 @@ "PoolIds": { "target": "com.amazonaws.workspaces#WorkspacesPoolIds", "traits": { - "smithy.api#documentation": "The identifier of the WorkSpaces pool.
" + "smithy.api#documentation": "The identifier of the WorkSpaces Pools.
" } }, "Filters": { "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilters", "traits": { - "smithy.api#documentation": "The filter conditions for the WorkSpaces pool to return.
" + "smithy.api#documentation": "The filter conditions for the WorkSpaces Pool to return.
" } }, "Limit": { @@ -5058,7 +5058,7 @@ "WorkspacesPools": { "target": "com.amazonaws.workspaces#WorkspacesPools", "traits": { - "smithy.api#documentation": "Information about the WorkSpaces pools.
" + "smithy.api#documentation": "Information about the WorkSpaces Pools.
" } }, "NextToken": { @@ -7125,7 +7125,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the network details of a WorkSpaces pool.
" + "smithy.api#documentation": "Describes the network details of a WorkSpaces Pool.
" } }, "com.amazonaws.workspaces#NonEmptyString": { @@ -7218,6 +7218,12 @@ "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2022" } + }, + "RHEL_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RHEL_8" + } } } }, @@ -8384,7 +8390,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts the specified WorkSpaces pool.
\nYou cannot start a WorkSpace pool unless it has a running mode of \n AutoStop and a state of STOPPED.
Starts the specified pool.
\nYou cannot start a pool unless it has a running mode of \n AutoStop and a state of STOPPED.
The identifier of the WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of the pool.
", "smithy.api#required": {} } } @@ -8502,7 +8508,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops the specifiedWorkSpaces pool.
\nYou cannot stop a WorkSpace pool unless it has a running mode of AutoStop \n and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
Stops the specified pool.
\nYou cannot stop a WorkSpace pool unless it has a running mode of AutoStop \n and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
The identifier of the WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of the pool.
", "smithy.api#required": {} } } @@ -8841,7 +8847,7 @@ } ], "traits": { - "smithy.api#documentation": "Terminates the specified WorkSpaces pool.
" + "smithy.api#documentation": "Terminates the specified pool.
" } }, "com.amazonaws.workspaces#TerminateWorkspacesPoolRequest": { @@ -8850,7 +8856,7 @@ "PoolId": { "target": "com.amazonaws.workspaces#WorkspacesPoolId", "traits": { - "smithy.api#documentation": "The identifier of the WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of the pool.
", "smithy.api#required": {} } } @@ -8892,7 +8898,7 @@ } ], "traits": { - "smithy.api#documentation": "Terminates the WorkSpaces pool session.
" + "smithy.api#documentation": "Terminates the pool session.
" } }, "com.amazonaws.workspaces#TerminateWorkspacesPoolSessionRequest": { @@ -8901,7 +8907,7 @@ "SessionId": { "target": "com.amazonaws.workspaces#AmazonUuid", "traits": { - "smithy.api#documentation": "The identifier of the WorkSpaces pool session.
", + "smithy.api#documentation": "The identifier of the pool session.
", "smithy.api#required": {} } } @@ -8969,7 +8975,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the timeout settings for a WorkSpaces pool.
" + "smithy.api#documentation": "Describes the timeout settings for a pool of WorkSpaces.
" } }, "com.amazonaws.workspaces#Timestamp": { @@ -9368,7 +9374,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified WorkSpaces pool.
" + "smithy.api#documentation": "Updates the specified pool.
" } }, "com.amazonaws.workspaces#UpdateWorkspacesPoolRequest": { @@ -9377,14 +9383,14 @@ "PoolId": { "target": "com.amazonaws.workspaces#WorkspacesPoolId", "traits": { - "smithy.api#documentation": "The identifier of the specified WorkSpaces pool to update.
", + "smithy.api#documentation": "The identifier of the specified pool to update.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.workspaces#UpdateDescription", "traits": { - "smithy.api#documentation": "Describes the specified WorkSpaces pool to update.
" + "smithy.api#documentation": "Describes the specified pool to update.
" } }, "BundleId": { @@ -9402,7 +9408,7 @@ "Capacity": { "target": "com.amazonaws.workspaces#Capacity", "traits": { - "smithy.api#documentation": "The desired capacity for the WorkSpaces pool.
" + "smithy.api#documentation": "The desired capacity for the pool.
" } }, "ApplicationSettings": { @@ -9414,7 +9420,7 @@ "TimeoutSettings": { "target": "com.amazonaws.workspaces#TimeoutSettings", "traits": { - "smithy.api#documentation": "Indicates the timeout settings of the specified WorkSpaces pool.
" + "smithy.api#documentation": "Indicates the timeout settings of the specified pool.
" } } }, @@ -9428,7 +9434,7 @@ "WorkspacesPool": { "target": "com.amazonaws.workspaces#WorkspacesPool", "traits": { - "smithy.api#documentation": "Describes the specified WorkSpaces pool.
" + "smithy.api#documentation": "Describes the specified pool.
" } } }, @@ -11148,14 +11154,14 @@ "PoolId": { "target": "com.amazonaws.workspaces#WorkspacesPoolId", "traits": { - "smithy.api#documentation": "The identifier of a WorkSpaces pool.
", + "smithy.api#documentation": "The identifier of a pool.
", "smithy.api#required": {} } }, "PoolArn": { "target": "com.amazonaws.workspaces#ARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the WorkSpaces pool.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the pool.
", "smithy.api#required": {} } }, @@ -11227,7 +11233,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a WorkSpaces pool.
" + "smithy.api#documentation": "Describes a pool of WorkSpaces.
" } }, "com.amazonaws.workspaces#WorkspacesPoolError": { @@ -11247,7 +11253,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a WorkSpaces pool error.
" + "smithy.api#documentation": "Describes a pool error.
" } }, "com.amazonaws.workspaces#WorkspacesPoolErrorCode": { @@ -11531,7 +11537,7 @@ "AuthenticationType": { "target": "com.amazonaws.workspaces#AuthenticationType", "traits": { - "smithy.api#documentation": "The authentication method. The user is authenticated using a WorkSpaces \n pool URL (API) or SAML 2.0 federation (SAML).
" + "smithy.api#documentation": "The authentication method. The user is authenticated using a \n WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
" } }, "ConnectionState": { @@ -11587,7 +11593,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes a WorkSpaces pool session.
" + "smithy.api#documentation": "Describes a pool session.
" } }, "com.amazonaws.workspaces#WorkspacesPoolSessions": {