Copy an AWS CloudHSM cluster backup to a different region.
" + "documentation":"Copy an CloudHSM cluster backup to a different region.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" }, "CreateCluster":{ "name":"CreateCluster", @@ -49,7 +50,7 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Creates a new AWS CloudHSM cluster.
" + "documentation":"Creates a new CloudHSM cluster.
Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.
" }, "CreateHsm":{ "name":"CreateHsm", @@ -66,7 +67,7 @@ {"shape":"CloudHsmResourceNotFoundException"}, {"shape":"CloudHsmAccessDeniedException"} ], - "documentation":"Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
" + "documentation":"Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.
" }, "DeleteBackup":{ "name":"DeleteBackup", @@ -83,7 +84,7 @@ {"shape":"CloudHsmResourceNotFoundException"}, {"shape":"CloudHsmServiceException"} ], - "documentation":"Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
" + "documentation":"Deletes a specified CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" }, "DeleteCluster":{ "name":"DeleteCluster", @@ -101,7 +102,7 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
" + "documentation":"Deletes the specified CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
" }, "DeleteHsm":{ "name":"DeleteHsm", @@ -118,7 +119,24 @@ {"shape":"CloudHsmInvalidRequestException"}, {"shape":"CloudHsmAccessDeniedException"} ], - "documentation":"Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
" + "documentation":"Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.
" + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" }, "DescribeBackups":{ "name":"DescribeBackups", @@ -136,7 +154,7 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an 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.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.
Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
" }, "DescribeClusters":{ "name":"DescribeClusters", @@ -153,7 +171,24 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
Gets information about CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.
" + }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"Retrieves the resource policy document attached to a given resource.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" }, "InitializeCluster":{ "name":"InitializeCluster", @@ -170,7 +205,7 @@ {"shape":"CloudHsmResourceNotFoundException"}, {"shape":"CloudHsmServiceException"} ], - "documentation":"Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
" + "documentation":"Claims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
" }, "ListTags":{ "name":"ListTags", @@ -188,7 +223,7 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
Gets a list of tags for the specified CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" }, "ModifyBackupAttributes":{ "name":"ModifyBackupAttributes", @@ -205,7 +240,7 @@ {"shape":"CloudHsmResourceNotFoundException"}, {"shape":"CloudHsmServiceException"} ], - "documentation":"Modifies attributes for AWS CloudHSM backup.
" + "documentation":"Modifies attributes for CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" }, "ModifyCluster":{ "name":"ModifyCluster", @@ -222,7 +257,24 @@ {"shape":"CloudHsmResourceNotFoundException"}, {"shape":"CloudHsmServiceException"} ], - "documentation":"Modifies AWS CloudHSM cluster.
" + "documentation":"Modifies CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
" + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:
Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.
In order to share a backup, it must be in a 'READY' state and you must own it.
While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working with shared backups in the CloudHSM User Guide
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" }, "RestoreBackup":{ "name":"RestoreBackup", @@ -239,7 +291,7 @@ {"shape":"CloudHsmResourceNotFoundException"}, {"shape":"CloudHsmServiceException"} ], - "documentation":"Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.
Restores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
" }, "TagResource":{ "name":"TagResource", @@ -257,7 +309,7 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
" + "documentation":"Adds or overwrites one or more tags for the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" }, "UntagResource":{ "name":"UntagResource", @@ -275,7 +327,7 @@ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmTagException"} ], - "documentation":"Removes the specified tag or tags from the specified AWS CloudHSM cluster.
" + "documentation":"Removes the specified tag or tags from the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
" } }, "shapes":{ @@ -287,6 +339,10 @@ "shape":"BackupId", "documentation":"The identifier (ID) of the backup.
" }, + "BackupArn":{ + "shape":"BackupArn", + "documentation":"The Amazon Resource Name (ARN) of the backup.
" + }, "BackupState":{ "shape":"BackupState", "documentation":"The state of the backup.
" @@ -329,14 +385,18 @@ }, "HsmType":{ "shape":"HsmType", - "documentation":"The HSM type of the cluster that was backed up.
" + "documentation":"The HSM type used to create the backup.
" }, "Mode":{ "shape":"ClusterMode", "documentation":"The mode of the cluster that was backed up.
" } }, - "documentation":"Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.
Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.
The HSM hardware certificate issued (signed) by AWS CloudHSM.
" + "documentation":"The HSM hardware certificate issued (signed) by CloudHSM.
" }, "ManufacturerHardwareCertificate":{ "shape":"Cert", @@ -428,12 +488,16 @@ "documentation":"The request was rejected because the requester does not have permission to perform the requested operation.
", "exception":true }, + "CloudHsmArn":{ + "type":"string", + "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}" + }, "CloudHsmInternalFailureException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, - "documentation":"The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
", + "documentation":"The request was rejected because of an CloudHSM internal failure. The request can be retried.
", "exception":true, "fault":true }, @@ -537,7 +601,7 @@ "documentation":"The mode of the cluster.
" } }, - "documentation":"Contains information about an AWS CloudHSM cluster.
" + "documentation":"Contains information about an CloudHSM cluster.
" }, "ClusterId":{ "type":"string", @@ -619,8 +683,8 @@ "documentation":"The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.
The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.
" + "shape":"BackupArn", + "documentation":"The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the 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.
" }, "SubnetIds":{ "shape":"SubnetIds", @@ -744,6 +808,28 @@ } } }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"CloudHsmArn", + "documentation":"Amazon Resource Name (ARN) of the resource from which the policy will be removed.
" + } + } + }, + "DeleteResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"CloudHsmArn", + "documentation":"Amazon Resource Name (ARN) of the resource from which the policy was deleted.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The policy previously attached to the resource.
" + } + } + }, "DescribeBackupsRequest":{ "type":"structure", "members":{ @@ -759,6 +845,10 @@ "shape":"Filters", "documentation":"One or more filters to limit the items returned in the response.
Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).
Use the sourceBackupIds filter to return only the backups created from a 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 clusters. Specify clusters by their cluster identifier (ID).
Use the states filter to return only backups that match the specified state.
Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.
Describe backups that are shared with you.
By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.
Designates whether or not to sort the return backups by ascending chronological order of generation.
" @@ -853,6 +943,24 @@ "value":{"shape":"Strings"}, "max":30 }, + "GetResourcePolicyRequest":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"CloudHsmArn", + "documentation":"Amazon Resource Name (ARN) of the resource to which a policy is attached.
" + } + } + }, + "GetResourcePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The policy attached to a resource.
" + } + } + }, "Hsm":{ "type":"structure", "required":["HsmId"], @@ -890,7 +998,7 @@ "documentation":"A description of the HSM's state.
" } }, - "documentation":"Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.
" + "documentation":"Contains information about a hardware security module (HSM) in an CloudHSM cluster.
" }, "HsmId":{ "type":"string", @@ -1047,6 +1155,32 @@ "max":32, "min":7 }, + "PutResourcePolicyRequest":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"CloudHsmArn", + "documentation":"Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The policy you want to associate with a resource.
For an example policy, see Working with shared backups in the CloudHSM User Guide
" + } + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"CloudHsmArn", + "documentation":"Amazon Resource Name (ARN) of the resource to which a policy is attached.
" + }, + "Policy":{ + "shape":"ResourcePolicy", + "documentation":"The policy attached to a resource.
" + } + } + }, "Region":{ "type":"string", "pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d" @@ -1055,6 +1189,11 @@ "type":"string", "pattern":"(?:cluster|backup)-[2-7a-zA-Z]{11,16}" }, + "ResourcePolicy":{ + "type":"string", + "max":20000, + "min":1 + }, "RestoreBackupRequest":{ "type":"structure", "required":["BackupId"], @@ -1191,5 +1330,5 @@ }, "errorMessage":{"type":"string"} }, - "documentation":"For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
" + "documentation":"For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide.
" } diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index 980943f613..d7b330d33f 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -11,7 +11,8 @@ "serviceId":"Connect", "signatureVersion":"v4", "signingName":"connect", - "uid":"connect-2017-08-08" + "uid":"connect-2017-08-08", + "auth":["aws.auth#sigv4"] }, "operations":{ "ActivateEvaluationForm":{ @@ -2098,7 +2099,7 @@ {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
" + "documentation":"Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation.
If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.
By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired.
For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.
" }, "ListAgentStatuses":{ "name":"ListAgentStatuses", @@ -3258,7 +3259,7 @@ {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], - "documentation":"Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
" + "documentation":"Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
" }, "StartContactEvaluation":{ "name":"StartContactEvaluation", @@ -3310,7 +3311,7 @@ {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], - "documentation":"Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
" + "documentation":"Initiates real-time message streaming for a new chat contact.
For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
" }, "StartOutboundVoiceContact":{ "name":"StartOutboundVoiceContact", @@ -4505,6 +4506,14 @@ }, "documentation":"A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
" }, + "AgentId":{ + "type":"string", + "max":256 + }, + "AgentIds":{ + "type":"list", + "member":{"shape":"AgentId"} + }, "AgentInfo":{ "type":"structure", "members":{ @@ -4702,6 +4711,16 @@ "max":100, "min":1 }, + "AgentsCriteria":{ + "type":"structure", + "members":{ + "AgentIds":{ + "shape":"AgentIds", + "documentation":"An object to specify a list of agents, by Agent ID.
" + } + }, + "documentation":"Can be used to define a list of preferred agents to target the contact within the queue. Note that agents must have the queue in their routing profile in order to be offered the contact.
" + }, "AgentsMinOneMaxHundred":{ "type":"list", "member":{"shape":"UserId"}, @@ -5389,9 +5408,13 @@ "documentation":"The value of predefined attribute.
" }, "ProficiencyLevel":{ - "shape":"ProficiencyLevel", + "shape":"NullableProficiencyLevel", "documentation":"The proficiency level of the condition.
" }, + "MatchCriteria":{ + "shape":"MatchCriteria", + "documentation":"An object to define AgentsCriteria.
The operator of the condition.
" @@ -11057,7 +11080,7 @@ }, "DoubleValue":{ "shape":"Double", - "documentation":"a Double number value type.
" + "documentation":"A Double number value type.
" }, "EmptyValue":{ "shape":"EmptyFieldValue", @@ -11589,7 +11612,7 @@ }, "Metrics":{ "shape":"MetricsV2", - "documentation":"The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Contacts answered in X seconds
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: Not available
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: API contacts handled
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: This metric is not available in Amazon Connect admin website.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Contacts resolved in X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Service level X
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The Negate key in Metric Level Filters is not applicable for this metric.
Unit: Count
Metric filter:
Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Contacts abandoned in X seconds
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for \"Less than\").
UI name: Contacts answered in X seconds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
An object to define AgentIds.
An object to define AgentsCriteria.
The type of notification recipient.
" }, + "NullableProficiencyLevel":{ + "type":"float", + "max":5.0, + "min":1.0 + }, "NumberReference":{ "type":"structure", "members":{ @@ -18196,7 +18234,7 @@ }, "SearchableContactAttributes":{ "shape":"SearchableContactAttributes", - "documentation":"The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more 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 contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
A structure of search criteria to be used to return contacts.
" @@ -19097,7 +19135,7 @@ "documentation":"An ascending or descending sort.
" } }, - "documentation":"A structure that defineds the field name to sort by and a sort order.
" + "documentation":"A structure that defines the field name to sort by and a sort order.
" }, "SortOrder":{ "type":"string", diff --git a/botocore/data/emr/2009-03-31/service-2.json b/botocore/data/emr/2009-03-31/service-2.json index 74f1654142..13c67608d3 100644 --- a/botocore/data/emr/2009-03-31/service-2.json +++ b/botocore/data/emr/2009-03-31/service-2.json @@ -5,12 +5,14 @@ "endpointPrefix":"elasticmapreduce", "jsonVersion":"1.1", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"Amazon EMR", "serviceFullName":"Amazon EMR", "serviceId":"EMR", "signatureVersion":"v4", "targetPrefix":"ElasticMapReduce", - "uid":"elasticmapreduce-2009-03-31" + "uid":"elasticmapreduce-2009-03-31", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddInstanceFleet":{ @@ -3123,6 +3125,10 @@ "CustomAmiId":{ "shape":"XmlStringMaxLen256", "documentation":"The custom AMI ID to use for the instance type.
" + }, + "Priority":{ + "shape":"NonNegativeDouble", + "documentation":"The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
" } }, "documentation":"An instance type configuration for each instance type in an instance fleet, which determines the Amazon EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
The custom AMI ID to use for the instance type.
" + }, + "Priority":{ + "shape":"NonNegativeDouble", + "documentation":"The priority at which Amazon EMR launches the Amazon EC2 instances with this instance type. Priority starts at 0, which is the highest priority. Amazon EMR considers the highest priority first.
" } }, "documentation":"The configuration specification for each instance type in an instance fleet.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.
Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first.
Specifies the strategy to use in launching On-Demand instance fleets. Available options are lowest-price and prioritized. lowest-price specifies to launch the instances with the lowest price first, and prioritized specifies that Amazon EMR should launch the instances with the highest priority first. The default is 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: capacity-optimized, price-capacity-optimized, lowest-price, or 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 launch specification for Spot Instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.
The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR releases 5.12.1 and later.
Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.
The Database object represents a logical grouping of tables that might reside 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 new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
" + "documentation":"Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
" }, "CheckpointConfigurationDescription":{ "type":"structure", @@ -2303,7 +2304,7 @@ "members":{ "CheckpointConfiguration":{ "shape":"CheckpointConfiguration", - "documentation":"Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
" + "documentation":"Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
" }, "MonitoringConfiguration":{ "shape":"MonitoringConfiguration", @@ -2333,7 +2334,7 @@ }, "JobPlanDescription":{ "shape":"JobPlanDescription", - "documentation":"The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
" + "documentation":"The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
" } }, "documentation":"Describes configuration parameters for a Managed Service for Apache Flink application.
" @@ -2361,7 +2362,7 @@ "members":{ "AllowNonRestoredState":{ "shape":"BooleanObject", - "documentation":"When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, 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 be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
Describes the starting parameters for a Managed Service for Apache Flink application.
" @@ -3368,7 +3369,7 @@ "documentation":"Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.
" } }, - "documentation":"Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
" + "documentation":"Describes parameters for how a Managed Service for Apache Flink application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.
" }, "ParallelismConfigurationDescription":{ "type":"structure", @@ -3772,7 +3773,8 @@ "ZEPPELIN-FLINK-2_0", "FLINK-1_15", "ZEPPELIN-FLINK-3_0", - "FLINK-1_18" + "FLINK-1_18", + "FLINK-1_19" ] }, "S3ApplicationCodeLocationDescription":{ diff --git a/botocore/data/opensearch/2021-01-01/service-2.json b/botocore/data/opensearch/2021-01-01/service-2.json index 733048f4c9..4414ddf9a9 100644 --- a/botocore/data/opensearch/2021-01-01/service-2.json +++ b/botocore/data/opensearch/2021-01-01/service-2.json @@ -1063,37 +1063,6 @@ } }, "shapes":{ - "AIMLOptionsInput":{ - "type":"structure", - "members":{ - "NaturalLanguageQueryGenerationOptions":{ - "shape":"NaturalLanguageQueryGenerationOptionsInput", - "documentation":"Container for parameters required for natural language query generation on the specified domain.
" - } - }, - "documentation":"Container for parameters required to enable all machine learning features.
" - }, - "AIMLOptionsOutput":{ - "type":"structure", - "members":{ - "NaturalLanguageQueryGenerationOptions":{ - "shape":"NaturalLanguageQueryGenerationOptionsOutput", - "documentation":"Container for parameters required for natural language query generation on the specified domain.
" - } - }, - "documentation":"Container for parameters representing the state of machine learning features on the specified domain.
" - }, - "AIMLOptionsStatus":{ - "type":"structure", - "members":{ - "Options":{ - "shape":"AIMLOptionsOutput", - "documentation":"Machine learning options on the specified domain.
" - }, - "Status":{"shape":"OptionStatus"} - }, - "documentation":"The status of machine learning options on the specified domain.
" - }, "ARN":{ "type":"string", "documentation":"The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
", @@ -2186,10 +2155,6 @@ "SoftwareUpdateOptions":{ "shape":"SoftwareUpdateOptions", "documentation":"Software update options for the domain.
" - }, - "AIMLOptions":{ - "shape":"AIMLOptionsInput", - "documentation":"Options for all machine learning features for the specified domain.
" } } }, @@ -3242,10 +3207,6 @@ "ModifyingProperties":{ "shape":"ModifyingPropertiesList", "documentation":"Information about the domain properties that are currently being modified.
" - }, - "AIMLOptions":{ - "shape":"AIMLOptionsStatus", - "documentation":"Container for parameters required to enable all machine learning features.
" } }, "documentation":"Container for the configuration of an OpenSearch Service domain.
" @@ -3653,10 +3614,6 @@ "ModifyingProperties":{ "shape":"ModifyingPropertiesList", "documentation":"Information about the domain properties that are currently being modified.
" - }, - "AIMLOptions":{ - "shape":"AIMLOptionsOutput", - "documentation":"Container for parameters required to enable all machine learning features.
" } }, "documentation":"The current status of an OpenSearch Service domain.
" @@ -4977,49 +4934,6 @@ "type":"list", "member":{"shape":"ModifyingProperties"} }, - "NaturalLanguageQueryGenerationCurrentState":{ - "type":"string", - "enum":[ - "NOT_ENABLED", - "ENABLE_COMPLETE", - "ENABLE_IN_PROGRESS", - "ENABLE_FAILED", - "DISABLE_COMPLETE", - "DISABLE_IN_PROGRESS", - "DISABLE_FAILED" - ] - }, - "NaturalLanguageQueryGenerationDesiredState":{ - "type":"string", - "enum":[ - "ENABLED", - "DISABLED" - ] - }, - "NaturalLanguageQueryGenerationOptionsInput":{ - "type":"structure", - "members":{ - "DesiredState":{ - "shape":"NaturalLanguageQueryGenerationDesiredState", - "documentation":"The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" - } - }, - "documentation":"Container for parameters required to enable the natural language query generation feature.
" - }, - "NaturalLanguageQueryGenerationOptionsOutput":{ - "type":"structure", - "members":{ - "DesiredState":{ - "shape":"NaturalLanguageQueryGenerationDesiredState", - "documentation":"The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" - }, - "CurrentState":{ - "shape":"NaturalLanguageQueryGenerationCurrentState", - "documentation":"The current state of the natural language query generation feature, indicating completion, in progress, or failure.
" - } - }, - "documentation":"Container for parameters representing the state of the natural language query generation feature on the specified domain.
" - }, "NextToken":{ "type":"string", "documentation":"When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
Service software update options for the domain.
" - }, - "AIMLOptions":{ - "shape":"AIMLOptionsInput", - "documentation":"Options for all machine learning features for the specified domain.
" } }, "documentation":"Container for the request parameters to the UpdateDomain operation.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.
A single filter for any other dimension in this dimension group.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.
A single filter for any other dimension in this dimension group.
The 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:
Any number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.
One or more filters to apply in the request. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.
The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.
A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).
Retrieves a list that describes the streaming sessions for a specified WorkSpaces pool.
" + "documentation":"Retrieves a list that describes the streaming sessions for a specified pool.
" }, "DescribeWorkspacesPools":{ "name":"DescribeWorkspacesPools", @@ -807,7 +807,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Describes the specified WorkSpaces pool.
" + "documentation":"Describes the specified WorkSpaces Pools.
" }, "DisassociateConnectionAlias":{ "name":"DisassociateConnectionAlias", @@ -1242,7 +1242,7 @@ {"shape":"OperationInProgressException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Starts the specified WorkSpaces pool.
You cannot start a WorkSpace pool unless it has a running mode of AutoStop and a state of STOPPED.
Starts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.
Stops the specifiedWorkSpaces pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
Stops the specified pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
Terminates the specified WorkSpaces pool.
" + "documentation":"Terminates the specified pool.
" }, "TerminateWorkspacesPoolSession":{ "name":"TerminateWorkspacesPoolSession", @@ -1313,7 +1313,7 @@ {"shape":"OperationInProgressException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Terminates the WorkSpaces pool session.
" + "documentation":"Terminates the pool session.
" }, "UpdateConnectClientAddIn":{ "name":"UpdateConnectClientAddIn", @@ -1417,7 +1417,7 @@ {"shape":"OperationInProgressException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Updates the specified WorkSpaces pool.
" + "documentation":"Updates the specified pool.
" } }, "shapes":{ @@ -1661,7 +1661,7 @@ "documentation":"The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.
" } }, - "documentation":"The persistent application settings for users of a WorkSpaces pool.
" + "documentation":"The persistent application settings for WorkSpaces Pools users.
" }, "ApplicationSettingsResponse":{ "type":"structure", @@ -1680,7 +1680,7 @@ "documentation":"The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
" } }, - "documentation":"Describes the persistent application settings for users of a WorkSpaces pool.
" + "documentation":"Describes the persistent application settings for WorkSpaces Pools users.
" }, "ApplicationSettingsStatusEnum":{ "type":"string", @@ -1923,7 +1923,7 @@ "documentation":"The desired number of user sessions for a multi-session pool. This is not allowed for single-session pools.
" } }, - "documentation":"Describes the user capacity for a WorkSpaces pool.
" + "documentation":"Describes the user capacity for a pool of WorkSpaces.
" }, "CapacityStatus":{ "type":"structure", @@ -1944,14 +1944,14 @@ }, "ActualUserSessions":{ "shape":"ActualUserSessions", - "documentation":"The total number of session slots that are available for WorkSpaces pools.
" + "documentation":"The total number of session slots that are available for a pool of WorkSpaces.
" }, "ActiveUserSessions":{ "shape":"ActiveUserSessions", "documentation":"The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
" } }, - "documentation":"Describes the capacity status for a WorkSpaces pool
" + "documentation":"Describes the capacity status for a pool of WorkSpaces.
" }, "CertificateAuthorityArn":{ "type":"string", @@ -2597,35 +2597,35 @@ "members":{ "PoolName":{ "shape":"WorkspacesPoolName", - "documentation":"The name of the WorkSpaces pool.
" + "documentation":"The name of the pool.
" }, "Description":{ "shape":"UpdateDescription", - "documentation":"The WorkSpaces pool description.
" + "documentation":"The pool description.
" }, "BundleId":{ "shape":"BundleId", - "documentation":"The identifier of the bundle for the WorkSpaces pool.
" + "documentation":"The identifier of the bundle for the pool.
" }, "DirectoryId":{ "shape":"DirectoryId", - "documentation":"The identifier of the directory for the WorkSpaces pool.
" + "documentation":"The identifier of the directory for the pool.
" }, "Capacity":{ "shape":"Capacity", - "documentation":"The user capacity of the WorkSpaces pool.
" + "documentation":"The user capacity of the pool.
" }, "Tags":{ "shape":"TagList", - "documentation":"The tags for the WorkSpaces pool.
" + "documentation":"The tags for the pool.
" }, "ApplicationSettings":{ "shape":"ApplicationSettingsRequest", - "documentation":"Indicates the application settings of the WorkSpaces pool.
" + "documentation":"Indicates the application settings of the pool.
" }, "TimeoutSettings":{ "shape":"TimeoutSettings", - "documentation":"Indicates the timeout settings of the WorkSpaces pool.
" + "documentation":"Indicates the timeout settings of the pool.
" } } }, @@ -2634,7 +2634,7 @@ "members":{ "WorkspacesPool":{ "shape":"WorkspacesPool", - "documentation":"Indicates the WorkSpaces pool to create.
" + "documentation":"Indicates the pool to create.
" } } }, @@ -3614,7 +3614,7 @@ "members":{ "PoolId":{ "shape":"WorkspacesPoolId", - "documentation":"The identifier of the WorkSpaces pool.
" + "documentation":"The identifier of the pool.
" }, "UserId":{ "shape":"WorkspacesPoolUserId", @@ -3635,7 +3635,7 @@ "members":{ "Sessions":{ "shape":"WorkspacesPoolSessions", - "documentation":"Describes the WorkSpaces pool sessions.
" + "documentation":"Describes the pool sessions.
" }, "NextToken":{ "shape":"PaginationToken", @@ -3657,14 +3657,14 @@ }, "Values":{ "shape":"DescribeWorkspacesPoolsFilterValues", - "documentation":"The values for filtering WorkSpaces pools.
" + "documentation":"The values for filtering WorkSpaces Pools.
" }, "Operator":{ "shape":"DescribeWorkspacesPoolsFilterOperator", - "documentation":"The operator values for filtering WorkSpaces pools.
" + "documentation":"The operator values for filtering WorkSpaces Pools.
" } }, - "documentation":"Describes the filter conditions for the WorkSpaces pool to return.
" + "documentation":"Describes the filter conditions for WorkSpaces Pools to return.
" }, "DescribeWorkspacesPoolsFilterName":{ "type":"string", @@ -3702,11 +3702,11 @@ "members":{ "PoolIds":{ "shape":"WorkspacesPoolIds", - "documentation":"The identifier of the WorkSpaces pool.
" + "documentation":"The identifier of the WorkSpaces Pools.
" }, "Filters":{ "shape":"DescribeWorkspacesPoolsFilters", - "documentation":"The filter conditions for the WorkSpaces pool to return.
" + "documentation":"The filter conditions for the WorkSpaces Pool to return.
" }, "Limit":{ "shape":"Limit", @@ -3723,7 +3723,7 @@ "members":{ "WorkspacesPools":{ "shape":"WorkspacesPools", - "documentation":"Information about the WorkSpaces pools.
" + "documentation":"Information about the WorkSpaces Pools.
" }, "NextToken":{ "shape":"PaginationToken", @@ -4736,7 +4736,7 @@ "documentation":"The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
" } }, - "documentation":"Describes the network details of a WorkSpaces pool.
" + "documentation":"Describes the network details of a WorkSpaces Pool.
" }, "NonEmptyString":{ "type":"string", @@ -4765,7 +4765,8 @@ "WINDOWS_7", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019", - "WINDOWS_SERVER_2022" + "WINDOWS_SERVER_2022", + "RHEL_8" ] }, "OperatingSystemNameList":{ @@ -5381,7 +5382,7 @@ "members":{ "PoolId":{ "shape":"WorkspacesPoolId", - "documentation":"The identifier of the WorkSpaces pool.
" + "documentation":"The identifier of the pool.
" } } }, @@ -5431,7 +5432,7 @@ "members":{ "PoolId":{ "shape":"WorkspacesPoolId", - "documentation":"The identifier of the WorkSpaces pool.
" + "documentation":"The identifier of the pool.
" } } }, @@ -5603,7 +5604,7 @@ "members":{ "PoolId":{ "shape":"WorkspacesPoolId", - "documentation":"The identifier of the WorkSpaces pool.
" + "documentation":"The identifier of the pool.
" } } }, @@ -5618,7 +5619,7 @@ "members":{ "SessionId":{ "shape":"AmazonUuid", - "documentation":"The identifier of the WorkSpaces pool session.
" + "documentation":"The identifier of the pool session.
" } } }, @@ -5662,7 +5663,7 @@ "documentation":"Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
" } }, - "documentation":"Describes the timeout settings for a WorkSpaces pool.
" + "documentation":"Describes the timeout settings for a pool of WorkSpaces.
" }, "Timestamp":{"type":"timestamp"}, "UnsupportedNetworkConfigurationException":{ @@ -5826,11 +5827,11 @@ "members":{ "PoolId":{ "shape":"WorkspacesPoolId", - "documentation":"The identifier of the specified WorkSpaces pool to update.
" + "documentation":"The identifier of the specified pool to update.
" }, "Description":{ "shape":"UpdateDescription", - "documentation":"Describes the specified WorkSpaces pool to update.
" + "documentation":"Describes the specified pool to update.
" }, "BundleId":{ "shape":"BundleId", @@ -5842,7 +5843,7 @@ }, "Capacity":{ "shape":"Capacity", - "documentation":"The desired capacity for the WorkSpaces pool.
" + "documentation":"The desired capacity for the pool.
" }, "ApplicationSettings":{ "shape":"ApplicationSettingsRequest", @@ -5850,7 +5851,7 @@ }, "TimeoutSettings":{ "shape":"TimeoutSettings", - "documentation":"Indicates the timeout settings of the specified WorkSpaces pool.
" + "documentation":"Indicates the timeout settings of the specified pool.
" } } }, @@ -5859,7 +5860,7 @@ "members":{ "WorkspacesPool":{ "shape":"WorkspacesPool", - "documentation":"Describes the specified WorkSpaces pool.
" + "documentation":"Describes the specified pool.
" } } }, @@ -6785,11 +6786,11 @@ "members":{ "PoolId":{ "shape":"WorkspacesPoolId", - "documentation":"The identifier of a WorkSpaces pool.
" + "documentation":"The identifier of a pool.
" }, "PoolArn":{ "shape":"ARN", - "documentation":"The Amazon Resource Name (ARN) for the WorkSpaces pool.
" + "documentation":"The Amazon Resource Name (ARN) for the pool.
" }, "CapacityStatus":{ "shape":"CapacityStatus", @@ -6832,7 +6833,7 @@ "documentation":"The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.
" } }, - "documentation":"Describes a WorkSpaces pool.
" + "documentation":"Describes a pool of WorkSpaces.
" }, "WorkspacesPoolError":{ "type":"structure", @@ -6846,7 +6847,7 @@ "documentation":"The error message.
" } }, - "documentation":"Describes a WorkSpaces pool error.
" + "documentation":"Describes a pool error.
" }, "WorkspacesPoolErrorCode":{ "type":"string", @@ -6921,7 +6922,7 @@ "members":{ "AuthenticationType":{ "shape":"AuthenticationType", - "documentation":"The authentication method. The user is authenticated using a WorkSpaces pool URL (API) or SAML 2.0 federation (SAML).
" + "documentation":"The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
" }, "ConnectionState":{ "shape":"SessionConnectionState", @@ -6956,7 +6957,7 @@ "documentation":"The identifier of the user.
" } }, - "documentation":"Describes a WorkSpaces pool session.
" + "documentation":"Describes a pool session.
" }, "WorkspacesPoolSessions":{ "type":"list", diff --git a/docs/source/conf.py b/docs/source/conf.py index a1bc18f982..0550a65a8e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.1' # The full version, including alpha/beta/rc tags. -release = '1.34.135' +release = '1.34.136' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.