Updates the device status as an administrator.
Calling this action requires developer credentials.
", "AdminUpdateUserAttributes": "Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Calling this action requires developer credentials.
", "AdminUserGlobalSignOut": "Signs out a user from all devices. You must sign AdminUserGlobalSignOut requests with Amazon Web Services credentials. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. The user's current access and ID tokens remain valid until they expire. By default, access and ID tokens expire one hour after they're issued. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the cookie validity period of 1 hour.
Calling this action requires developer credentials.
", - "AssociateSoftwareToken": "Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
Calling AssociateSoftwareToken immediately disassociates the existing software token from the user account. If the user doesn't subsequently verify the software token, their account is set up to authenticate without MFA. If MFA config is set to Optional at the user pool level, the user can then log in without MFA. However, if MFA is set to Required for the user pool, the user is asked to set up a new software token MFA during sign-in.
Begins setup of time-based one-time password multi-factor authentication (TOTP MFA) for a user, with a unique private key that Amazon Cognito generates and returns in the API response. You can authorize an AssociateSoftwareToken request with either the user's access token, or a session string from a challenge response that you received from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a VerifySoftwareToken API request. If you don't verify the software token and your user pool doesn't require MFA, the user can then authenticate with user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup with AssociateSoftwareToken and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge with your user's TOTP.
Changes the password for a specified user in a user pool.
", "ConfirmDevice": "Confirms tracking of the device. This API call is the call that begins device tracking.
", "ConfirmForgotPassword": "Allows a user to enter a confirmation code to reset a forgotten password.
", @@ -444,7 +444,7 @@ } }, "AliasExistsException": { - "base": "This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias from a different account. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
", + "base": "This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.
", "refs": { } }, @@ -913,8 +913,8 @@ "ContextDataType": { "base": "Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", "refs": { - "AdminInitiateAuthRequest$ContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "AdminRespondToAuthChallengeRequest$ContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "AdminInitiateAuthRequest$ContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "AdminRespondToAuthChallengeRequest$ContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
" } }, "CreateGroupRequest": { @@ -1468,7 +1468,7 @@ } }, "ForgotPasswordResponse": { - "base": "Represents the response from the server regarding the request to reset a password.
", + "base": "The response from Amazon Cognito to a request to reset a password.
", "refs": { } }, @@ -2614,15 +2614,15 @@ "ClientMetadataType$key": null, "ClientMetadataType$value": null, "CodeDeliveryDetailsType$Destination": "The email address or phone number destination where Amazon Cognito sent the code.
", - "ContextDataType$IpAddress": "Source IP address of your user.
", + "ContextDataType$IpAddress": "The source IP address of your user's device.
", "ContextDataType$ServerName": "Your server endpoint where this API is invoked.
", "ContextDataType$ServerPath": "Your server path where this API is invoked.
", - "ContextDataType$EncodedData": "Encoded data containing device fingerprinting details collected using the Amazon Cognito context data collection library.
", + "ContextDataType$EncodedData": "Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
", "DeviceSecretVerifierConfigType$PasswordVerifier": "The password verifier.
", "DeviceSecretVerifierConfigType$Salt": "The salt
", "DomainDescriptionType$CloudFrontDistribution": "The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
", "EmailConfigurationType$From": "Either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address appears before the body of the email.
The user's IP address.
", + "EventContextDataType$IpAddress": "The source IP address of your user's device.
", "EventContextDataType$DeviceName": "The user's device name.
", "EventContextDataType$Timezone": "The user's time zone.
", "EventContextDataType$City": "The user's city.
", @@ -2647,7 +2647,8 @@ "SmsConfigurationType$ExternalId": "The external ID provides additional security for your IAM role. You can use an ExternalId with the IAM role that you use with Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, your Amazon Cognito user pool includes it in the request to assume your IAM role. You can configure the role trust policy to require that Amazon Cognito, and any principal, provide the ExternalID. If you use the Amazon Cognito Management Console to create a role for SMS multi-factor authentication (MFA), Amazon Cognito creates a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
For more information about the ExternalId of a role, see How to use an external ID when granting access to your Amazon Web Services resources to a third party
The minimum length.
", "StringAttributeConstraintsType$MaxLength": "The maximum length.
", - "UserContextDataType$EncodedData": "Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", + "UserContextDataType$IpAddress": "The source IP address of your user's device.
", + "UserContextDataType$EncodedData": "Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.
", "UserMFASettingListType$member": null, "UserPoolType$SmsConfigurationFailure": "The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in AccessTokenValidity, defaulting to hours.
", - "TokenValidityUnitsType$IdToken": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in IdTokenValidity, defaulting to hours.
", - "TokenValidityUnitsType$RefreshToken": "A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in RefreshTokenValidity, defaulting to days.
" + "TokenValidityUnitsType$AccessToken": " A time unit of seconds, minutes, hours, or days for the value that you set in the AccessTokenValidity parameter. The default AccessTokenValidity time unit is hours.
A time unit of seconds, minutes, hours, or days for the value that you set in the IdTokenValidity parameter. The default IdTokenValidity time unit is hours.
A time unit of seconds, minutes, hours, or days for the value that you set in the RefreshTokenValidity parameter. The default RefreshTokenValidity time unit is days.
The settings for updates to user attributes.
", + "base": "The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to to email addresses and phone numbers.
Information that your app generates about a user's AdminInitiateAuth or AdminRespondToAuthChallenge session. Amazon Cognito advanced security features calculate risk levels for user sessions based on this context data.
Contextual data, such as the user's device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", "refs": { - "ConfirmForgotPasswordRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "ConfirmSignUpRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "ForgotPasswordRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "InitiateAuthRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "ResendConfirmationCodeRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "RespondToAuthChallengeRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", - "SignUpRequest$UserContextData": "Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "ConfirmForgotPasswordRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "ConfirmSignUpRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "ForgotPasswordRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "InitiateAuthRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "ResendConfirmationCodeRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "RespondToAuthChallengeRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
", + "SignUpRequest$UserContextData": "Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
" } }, "UserFilterType": { @@ -3292,9 +3293,12 @@ "base": null, "refs": { "CreateUserPoolClientRequest$EnableTokenRevocation": "Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
", + "CreateUserPoolClientRequest$EnablePropagateAdditionalUserContextData": "Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether compromised credentials were detected during an authentication event.
", "UpdateUserPoolClientRequest$EnableTokenRevocation": "Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
", + "UpdateUserPoolClientRequest$EnablePropagateAdditionalUserContextData": "Activates the propagation of additional user context data. For more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
", + "UserPoolClientType$EnablePropagateAdditionalUserContextData": "When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.
Valid values include:
Enables case sensitivity for all username input. When this option is set to True, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.
Enables case insensitivity for all username input. For example, when this option is set to False, users can sign in using either \"username\" or \"Username\". This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.
AWS Elastic Disaster Recovery Service.
", "operations": { + "CreateExtendedSourceServer": "Create an extended source server in the target Account based on the source server in staging account.
", "CreateReplicationConfigurationTemplate": "Creates a new ReplicationConfigurationTemplate.
", "DeleteJob": "Deletes a single Job by ID.
", "DeleteRecoveryInstance": "Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
", @@ -19,6 +20,8 @@ "GetLaunchConfiguration": "Gets a LaunchConfiguration, filtered by Source Server IDs.
", "GetReplicationConfiguration": "Gets a ReplicationConfiguration, filtered by Source Server ID.
", "InitializeService": "Initialize Elastic Disaster Recovery.
", + "ListExtensibleSourceServers": "Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.
", + "ListStagingAccounts": "Returns an array of staging accounts for existing extended source servers.
", "ListTagsForResource": "List all tags for your Elastic Disaster Recovery resources.
", "RetryDataReplication": "Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
", "StartFailbackLaunch": "Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
", @@ -44,6 +47,7 @@ "ReplicationConfigurationTemplate$arn": "The Replication Configuration Template ARN.
", "ReplicationConfigurationTemplate$ebsEncryptionKeyArn": "The ARN of the EBS encryption key to be used during replication.
", "SourceServer$arn": "The ARN of the Source Server.
", + "StagingArea$stagingSourceServerArn": "Arn of the staging source server if this source server is extended
", "TagResourceRequest$resourceArn": "ARN of the resource for which tags are to be added or updated.
", "UntagResourceRequest$resourceArn": "ARN of the resource for which tags are to be removed.
", "UpdateReplicationConfigurationRequest$ebsEncryptionKeyArn": "The ARN of the EBS encryption key to be used during replication.
", @@ -52,13 +56,41 @@ } }, "AccessDeniedException": { - "base": "TYou do not have sufficient access to perform this action.
", + "base": "You do not have sufficient access to perform this action.
", "refs": { } }, + "Account": { + "base": "AWS account.
", + "refs": { + "Accounts$member": null + } + }, + "AccountID": { + "base": null, + "refs": { + "Account$accountID": "Account ID of AWS account.
", + "AccountIDs$member": null, + "ListExtensibleSourceServersRequest$stagingAccountID": "The Id of the staging Account to retrieve extensible source servers from.
", + "StagingArea$stagingAccountID": "Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
" + } + }, + "AccountIDs": { + "base": null, + "refs": { + "DescribeSourceServersRequestFilters$stagingAccountIDs": "An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.
" + } + }, + "Accounts": { + "base": null, + "refs": { + "ListStagingAccountsResponse$accounts": "An array of staging AWS Accounts.
" + } + }, "Boolean": { "base": null, "refs": { + "ConversionProperties$forceUefi": "Whether the volume being converted uses UEFI or not
", "CreateReplicationConfigurationTemplateRequest$associateDefaultSecurityGroup": "Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
", "CreateReplicationConfigurationTemplateRequest$createPublicIP": "Whether to create a Public IP for the Recovery Instance by default.
", "CreateReplicationConfigurationTemplateRequest$useDedicatedReplicationServer": "Whether to use a dedicated Replication Server in the replication staging area.
", @@ -108,6 +140,7 @@ "RecoveryInstanceDisk$internalDeviceName": "The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.
", "RecoveryInstanceFailback$failbackClientID": "The ID of the failback client that this Recovery Instance is associated with.
", "ReplicationConfigurationReplicatedDisk$deviceName": "The name of the device.
", + "StagingSourceServer$hostname": "Hostname of staging source server.
", "UpdateFailbackReplicationConfigurationRequest$name": "The name of the Failback Replication Configuration.
" } }, @@ -122,6 +155,18 @@ "refs": { } }, + "ConversionMap": { + "base": null, + "refs": { + "VolumeToConversionMap$value": null + } + }, + "ConversionProperties": { + "base": "Properties of a conversion job
", + "refs": { + "JobLogEventData$conversionProperties": "Properties of a conversion job
" + } + }, "Cpus": { "base": null, "refs": { @@ -129,6 +174,16 @@ "SourceProperties$cpus": "An array of CPUs.
" } }, + "CreateExtendedSourceServerRequest": { + "base": null, + "refs": { + } + }, + "CreateExtendedSourceServerResponse": { + "base": null, + "refs": { + } + }, "CreateReplicationConfigurationTemplateRequest": { "base": null, "refs": { @@ -397,6 +452,12 @@ "RecoveryInstanceDisk$ebsVolumeID": "The EBS Volume ID of this disk.
" } }, + "ExtensionStatus": { + "base": null, + "refs": { + "StagingArea$status": "Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
" + } + }, "FailbackReplicationError": { "base": null, "refs": { @@ -569,6 +630,8 @@ "ConflictException$message": null, "ConflictException$resourceId": "The ID of the resource.
", "ConflictException$resourceType": "The type of the resource.
", + "ConversionProperties$dataTimestamp": "The timestamp of when the snapshot being converted was taken
", + "ConversionProperties$rootVolumeName": "The root volume name of a conversion job
", "DataReplicationError$rawError": "Error in data replication.
", "InternalServerException$message": null, "JobLogEventData$rawError": "A string representing a job error.
", @@ -583,6 +646,7 @@ "ServiceQuotaExceededException$resourceId": "The ID of the resource.
", "ServiceQuotaExceededException$resourceType": "The type of the resource.
", "ServiceQuotaExceededException$serviceCode": "Service code.
", + "StagingArea$errorMessage": "Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
", "ThrottlingException$message": null, "ThrottlingException$quotaCode": "Quota code.
", "ThrottlingException$retryAfterSeconds": "The number of seconds after which the request should be safe to retry.
", @@ -592,7 +656,9 @@ "ValidationException$code": null, "ValidationException$message": null, "ValidationExceptionField$message": "Validate exception field message.
", - "ValidationExceptionField$name": "Validate exception field name.
" + "ValidationExceptionField$name": "Validate exception field name.
", + "VolumeToConversionMap$key": null, + "VolumeToSizeMap$key": null } }, "LastLaunchResult": { @@ -650,6 +716,32 @@ "LifeCycleLastLaunch$initiated": "An object containing information regarding the initiation of the last launch of a Source Server.
" } }, + "ListExtensibleSourceServersRequest": { + "base": null, + "refs": { + } + }, + "ListExtensibleSourceServersResponse": { + "base": null, + "refs": { + } + }, + "ListStagingAccountsRequest": { + "base": null, + "refs": { + } + }, + "ListStagingAccountsRequestMaxResultsInteger": { + "base": null, + "refs": { + "ListStagingAccountsRequest$maxResults": "The maximum number of staging Accounts to retrieve.
" + } + }, + "ListStagingAccountsResponse": { + "base": null, + "refs": { + } + }, "ListTagsForResourceRequest": { "base": null, "refs": { @@ -660,6 +752,12 @@ "refs": { } }, + "MaxResultsReplicatingSourceServers": { + "base": null, + "refs": { + "ListExtensibleSourceServersRequest$maxResults": "The maximum number of extensible source servers to retrieve.
" + } + }, "NetworkInterface": { "base": "Network interface.
", "refs": { @@ -716,7 +814,11 @@ "DescribeReplicationConfigurationTemplatesRequest$nextToken": "The token of the next Replication Configuration Template to retrieve.
", "DescribeReplicationConfigurationTemplatesResponse$nextToken": "The token of the next Replication Configuration Template to retrieve.
", "DescribeSourceServersRequest$nextToken": "The token of the next Source Server to retrieve.
", - "DescribeSourceServersResponse$nextToken": "The token of the next Source Server to retrieve.
" + "DescribeSourceServersResponse$nextToken": "The token of the next Source Server to retrieve.
", + "ListExtensibleSourceServersRequest$nextToken": "The token of the next extensible source server to retrieve.
", + "ListExtensibleSourceServersResponse$nextToken": "The token of the next extensible source server to retrieve.
", + "ListStagingAccountsRequest$nextToken": "The token of the next staging Account to retrieve.
", + "ListStagingAccountsResponse$nextToken": "The token of the next staging Account to retrieve.
" } }, "ParticipatingServer": { @@ -757,7 +859,8 @@ "SourceProperties$ramBytes": "The amount of RAM in bytes.
", "UpdateFailbackReplicationConfigurationRequest$bandwidthThrottling": "Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
", "UpdateReplicationConfigurationRequest$bandwidthThrottling": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
", - "UpdateReplicationConfigurationTemplateRequest$bandwidthThrottling": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
" + "UpdateReplicationConfigurationTemplateRequest$bandwidthThrottling": "Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
", + "VolumeToSizeMap$value": null } }, "RecoveryInstance": { @@ -1034,9 +1137,17 @@ "SourceServer": { "base": null, "refs": { + "CreateExtendedSourceServerResponse$sourceServer": "Created extended source server.
", "SourceServersList$member": null } }, + "SourceServerARN": { + "base": null, + "refs": { + "CreateExtendedSourceServerRequest$sourceServerArn": "This defines the ARN of the source server in staging Account based on which you want to create an extended source server.
", + "StagingSourceServer$arn": "The ARN of the source server.
" + } + }, "SourceServerID": { "base": null, "refs": { @@ -1072,6 +1183,24 @@ "DescribeSourceServersResponse$items": "An array of Source Servers.
" } }, + "StagingArea": { + "base": "Staging information related to source server.
", + "refs": { + "SourceServer$stagingArea": "The staging area of the source server.
" + } + }, + "StagingSourceServer": { + "base": "Source server in staging account that extended source server connected to.
", + "refs": { + "StagingSourceServersList$member": null + } + }, + "StagingSourceServersList": { + "base": null, + "refs": { + "ListExtensibleSourceServersResponse$items": "A list of source servers on a staging Account that are extensible.
" + } + }, "StartFailbackLaunchRequest": { "base": null, "refs": { @@ -1165,6 +1294,7 @@ "TagsMap": { "base": null, "refs": { + "CreateExtendedSourceServerRequest$tags": "A list of tags associated with the extended source server.
", "CreateReplicationConfigurationTemplateRequest$stagingAreaTags": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
", "CreateReplicationConfigurationTemplateRequest$tags": "A set of tags to be associated with the Replication Configuration Template resource.
", "Job$tags": "A list of tags associated with the Job.
", @@ -1174,6 +1304,7 @@ "ReplicationConfigurationTemplate$stagingAreaTags": "A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
", "ReplicationConfigurationTemplate$tags": "A set of tags to be associated with the Replication Configuration Template resource.
", "SourceServer$tags": "The tags associated with the Source Server.
", + "StagingSourceServer$tags": "A list of tags associated with the staging source server.
", "StartFailbackLaunchRequest$tags": "The tags to be associated with the failback launch Job.
", "StartRecoveryRequest$tags": "The tags to be associated with the Recovery Job.
", "TagResourceRequest$tags": "Array of tags to be added or updated.
", @@ -1256,9 +1387,23 @@ "ValidationException$reason": "Validation exception reason.
" } }, + "VolumeToConversionMap": { + "base": null, + "refs": { + "ConversionProperties$volumeToConversionMap": "A mapping between the volumes being converted and the converted snapshot ids
" + } + }, + "VolumeToSizeMap": { + "base": null, + "refs": { + "ConversionProperties$volumeToVolumeSize": "A mapping between the volumes and their sizes
" + } + }, "ebsSnapshot": { "base": null, "refs": { + "ConversionMap$key": null, + "ConversionMap$value": null, "EbsSnapshotsList$member": null } } diff --git a/models/apis/drs/2020-02-26/paginators-1.json b/models/apis/drs/2020-02-26/paginators-1.json index 1b140e716c2..d3867f19311 100644 --- a/models/apis/drs/2020-02-26/paginators-1.json +++ b/models/apis/drs/2020-02-26/paginators-1.json @@ -35,6 +35,18 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "items" + }, + "ListExtensibleSourceServers": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListStagingAccounts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "accounts" } } } diff --git a/models/apis/iotsitewise/2019-12-02/api-2.json b/models/apis/iotsitewise/2019-12-02/api-2.json index 1b6f1033c81..e26ba18b982 100644 --- a/models/apis/iotsitewise/2019-12-02/api-2.json +++ b/models/apis/iotsitewise/2019-12-02/api-2.json @@ -1568,7 +1568,8 @@ "creationDate":{"shape":"Timestamp"}, "lastUpdateDate":{"shape":"Timestamp"}, "status":{"shape":"AssetStatus"}, - "hierarchies":{"shape":"AssetHierarchies"} + "hierarchies":{"shape":"AssetHierarchies"}, + "description":{"shape":"Description"} } }, "AssociateAssetsRequest":{ @@ -1645,7 +1646,8 @@ "creationDate":{"shape":"Timestamp"}, "lastUpdateDate":{"shape":"Timestamp"}, "status":{"shape":"AssetStatus"}, - "hierarchies":{"shape":"AssetHierarchies"} + "hierarchies":{"shape":"AssetHierarchies"}, + "description":{"shape":"Description"} } }, "Attribute":{ @@ -2282,7 +2284,8 @@ "shape":"ClientToken", "idempotencyToken":true }, - "tags":{"shape":"TagMap"} + "tags":{"shape":"TagMap"}, + "assetDescription":{"shape":"Description"} } }, "CreateAssetResponse":{ @@ -2770,7 +2773,8 @@ "assetCompositeModels":{"shape":"AssetCompositeModels"}, "assetCreationDate":{"shape":"Timestamp"}, "assetLastUpdateDate":{"shape":"Timestamp"}, - "assetStatus":{"shape":"AssetStatus"} + "assetStatus":{"shape":"AssetStatus"}, + "assetDescription":{"shape":"Description"} } }, "DescribeDashboardRequest":{ @@ -4760,7 +4764,8 @@ "clientToken":{ "shape":"ClientToken", "idempotencyToken":true - } + }, + "assetDescription":{"shape":"Description"} } }, "UpdateAssetResponse":{ diff --git a/models/apis/iotsitewise/2019-12-02/docs-2.json b/models/apis/iotsitewise/2019-12-02/docs-2.json index 56d81905cba..005fdbaa566 100644 --- a/models/apis/iotsitewise/2019-12-02/docs-2.json +++ b/models/apis/iotsitewise/2019-12-02/docs-2.json @@ -1187,18 +1187,23 @@ "AssetModelCompositeModel$description": "The description of the composite model.
", "AssetModelCompositeModelDefinition$description": "The description of the composite model.
", "AssetModelSummary$description": "The asset model description.
", + "AssetSummary$description": "A description for the asset.
", + "AssociatedAssetsSummary$description": "A description for the asset.
", "CreateAssetModelRequest$assetModelDescription": "A description for the asset model.
", + "CreateAssetRequest$assetDescription": "A description for the asset.
", "CreateDashboardRequest$dashboardDescription": "A description for the dashboard.
", "CreatePortalRequest$portalDescription": "A description for the portal.
", "CreateProjectRequest$projectDescription": "A description for the project.
", "DashboardSummary$description": "The dashboard's description.
", "DescribeAssetModelResponse$assetModelDescription": "The asset model's description.
", + "DescribeAssetResponse$assetDescription": "A description for the asset.
", "DescribeDashboardResponse$dashboardDescription": "The dashboard's description.
", "DescribePortalResponse$portalDescription": "The portal's description.
", "DescribeProjectResponse$projectDescription": "The project's description.
", "PortalSummary$description": "The portal's description.
", "ProjectSummary$description": "The project's description.
", "UpdateAssetModelRequest$assetModelDescription": "A description for the asset model.
", + "UpdateAssetRequest$assetDescription": "A description for the asset.
", "UpdateDashboardRequest$dashboardDescription": "A new description for the dashboard.
", "UpdatePortalRequest$portalDescription": "A new description for the portal.
", "UpdateProjectRequest$projectDescription": "A new description for the project.
" @@ -2335,9 +2340,9 @@ "StorageType": { "base": null, "refs": { - "DescribeStorageConfigurationResponse$storageType": "The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. The cold tier is a customer-managed Amazon S3 bucket.
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. The cold tier is a customer-managed Amazon S3 bucket.
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. The cold tier is a customer-managed Amazon S3 bucket.
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
The storage tier that you specified for your data. The storageType parameter can be one of the following values:
SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.
MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
Settings for backtest mode.
", "refs": { - "AthenaSourceConfig$BackTestConfiguration": "Settings for backtest mode.
" + "AthenaSourceConfig$BackTestConfiguration": "Settings for backtest mode.
", + "CloudWatchConfig$BackTestConfiguration": "Settings for backtest mode.
" } }, "BinaryAttributeValue": { diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index 11df74dba9f..a07acf22e1c 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -13140,7 +13140,7 @@ "PlatformIdentifier":{ "type":"string", "max":15, - "pattern":"^(notebook-al1-v1|notebook-al2-v1)$" + "pattern":"^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$" }, "PolicyString":{ "type":"string", diff --git a/models/apis/transcribe/2017-10-26/api-2.json b/models/apis/transcribe/2017-10-26/api-2.json index 72febbd2fe8..3ad2810f69c 100644 --- a/models/apis/transcribe/2017-10-26/api-2.json +++ b/models/apis/transcribe/2017-10-26/api-2.json @@ -939,6 +939,7 @@ "LanguageModel":{"shape":"LanguageModel"} } }, + "DurationInSeconds":{"type":"float"}, "FailureReason":{"type":"string"}, "GetCallAnalyticsCategoryRequest":{ "type":"structure", @@ -1140,6 +1141,17 @@ "en-NZ" ] }, + "LanguageCodeItem":{ + "type":"structure", + "members":{ + "LanguageCode":{"shape":"LanguageCode"}, + "DurationInSeconds":{"shape":"DurationInSeconds"} + } + }, + "LanguageCodeList":{ + "type":"list", + "member":{"shape":"LanguageCodeItem"} + }, "LanguageIdSettings":{ "type":"structure", "members":{ @@ -1627,8 +1639,7 @@ "type":"structure", "required":[ "CallAnalyticsJobName", - "Media", - "DataAccessRoleArn" + "Media" ], "members":{ "CallAnalyticsJobName":{"shape":"CallAnalyticsJobName"}, @@ -1700,6 +1711,7 @@ "JobExecutionSettings":{"shape":"JobExecutionSettings"}, "ContentRedaction":{"shape":"ContentRedaction"}, "IdentifyLanguage":{"shape":"Boolean"}, + "IdentifyMultipleLanguages":{"shape":"Boolean"}, "LanguageOptions":{"shape":"LanguageOptions"}, "Subtitles":{"shape":"Subtitles"}, "Tags":{"shape":"TagList"}, @@ -1858,8 +1870,10 @@ "JobExecutionSettings":{"shape":"JobExecutionSettings"}, "ContentRedaction":{"shape":"ContentRedaction"}, "IdentifyLanguage":{"shape":"Boolean"}, + "IdentifyMultipleLanguages":{"shape":"Boolean"}, "LanguageOptions":{"shape":"LanguageOptions"}, "IdentifiedLanguageScore":{"shape":"IdentifiedLanguageScore"}, + "LanguageCodes":{"shape":"LanguageCodeList"}, "Tags":{"shape":"TagList"}, "Subtitles":{"shape":"SubtitlesOutput"}, "LanguageIdSettings":{"shape":"LanguageIdSettingsMap"} @@ -1898,7 +1912,9 @@ "ContentRedaction":{"shape":"ContentRedaction"}, "ModelSettings":{"shape":"ModelSettings"}, "IdentifyLanguage":{"shape":"Boolean"}, - "IdentifiedLanguageScore":{"shape":"IdentifiedLanguageScore"} + "IdentifyMultipleLanguages":{"shape":"Boolean"}, + "IdentifiedLanguageScore":{"shape":"IdentifiedLanguageScore"}, + "LanguageCodes":{"shape":"LanguageCodeList"} } }, "Type":{ diff --git a/models/apis/transcribe/2017-10-26/docs-2.json b/models/apis/transcribe/2017-10-26/docs-2.json index 7f5e2a088ac..a069dba5a5d 100644 --- a/models/apis/transcribe/2017-10-26/docs-2.json +++ b/models/apis/transcribe/2017-10-26/docs-2.json @@ -1,59 +1,59 @@ { "version": "2.0", - "service": "Operations and objects for transcribing speech to text.
", + "service": "Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.
Standard transcriptions are the most common option. Refer to for details.
Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.
Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.
Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: \"Please note this call may be recorded.\") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.
", - "CreateLanguageModel": "Creates a new custom language model. When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.
", - "CreateMedicalVocabulary": "Creates a new custom medical vocabulary.
When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag, as CreateMedicalVocabulary does not support the Phrases flag.
For more information on creating a custom vocabulary text file, see Creating a custom vocabulary.
", - "CreateVocabulary": "Creates a new custom vocabulary.
When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the Phrases flag.
For more information on creating a custom vocabulary, see Creating a custom vocabulary.
", - "CreateVocabularyFilter": "Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript.
", - "DeleteCallAnalyticsCategory": "Deletes a call analytics category. To use this operation, specify the name of the category you want to delete using CategoryName.
Deletes a call analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName.
Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName.
Deletes a medical transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName.
Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.
Deletes a transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using TranscriptionJobName.
Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.
Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName.
Provides information about a specific custom language model in your Amazon Web Services account.
This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use this operation to help identify the reason.
", - "GetCallAnalyticsCategory": "Retrieves information about a call analytics category.
", - "GetCallAnalyticsJob": "Retrieves information about a call analytics job.
To view the job's status, refer to the CallAnalyticsJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.
Retrieves information about a medical transcription job.
To view the job's status, refer to the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field.
Retrieves information about a medical vocabulary.
", - "GetTranscriptionJob": "Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.
Gets information about a vocabulary.
", - "GetVocabularyFilter": "Returns information about a vocabulary filter.
", - "ListCallAnalyticsCategories": "Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.
", - "ListCallAnalyticsJobs": "List call analytics jobs with a specified status or substring that matches their names.
", - "ListLanguageModels": "Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.
", - "ListMedicalTranscriptionJobs": "Lists medical transcription jobs with a specified status or substring that matches their names.
", - "ListMedicalVocabularies": "Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.
", - "ListTagsForResource": "Lists all tags associated with a given transcription job, vocabulary, or resource.
", - "ListTranscriptionJobs": "Lists transcription jobs with the specified status.
", - "ListVocabularies": "Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
", - "ListVocabularyFilters": "Gets information about vocabulary filters.
", - "StartCallAnalyticsJob": "Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.
", - "StartMedicalTranscriptionJob": "Starts a batch job to transcribe medical speech to text.
", - "StartTranscriptionJob": "Starts an asynchronous job to transcribe speech to text.
", - "TagResource": "Tags an Amazon Transcribe resource with the given list of tags.
", - "UntagResource": "Removes specified tags from a specified Amazon Transcribe resource.
", - "UpdateCallAnalyticsCategory": "Updates the call analytics category with new values. The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.
Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.
Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
Updates a vocabulary filter with a new list of filtered words.
" + "CreateCallAnalyticsCategory": "Creates a new Call Analytics category.
All categories are automatically applied to your Call Analytics jobs. Note that in order to apply your categories to your jobs, you must create them before submitting your job request, as categories cannot be applied retroactively.
Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .
To update an existing category, see .
To learn more about:
Call Analytics categories, see Creating categories
Using rules, see Rule criteria and refer to the data type
Call Analytics, see Analyzing call center audio with Call Analytics
Creates a new custom language model.
When creating a new language model, you must specify:
If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model
The location of your training and tuning files (this must be an Amazon S3 URI)
The language of your model
A unique name for your model
For more information, see Custom language models.
", + "CreateMedicalVocabulary": "Creates a new custom medical vocabulary.
Prior to creating a new medical vocabulary, you must first upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Creating a custom vocabulary.
", + "CreateVocabulary": "Creates a new custom vocabulary.
When creating a new vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request, or you can include a list of terms directly in your request using the Phrases flag.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Creating a custom vocabulary.
", + "CreateVocabularyFilter": "Creates a new custom vocabulary filter.
You can use vocabulary filters to mask, delete, or flag specific words from your transcript. Vocabulary filters are commonly used to mask profanity in transcripts.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
For more information, see Using vocabulary filtering with unwanted words.
", + "DeleteCallAnalyticsCategory": "Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.
Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive.
Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. Language model names are case sensitive.
Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.
Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName. Vocabulary names are case sensitive.
Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.
Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName. Vocabulary names are case sensitive.
Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName. Vocabulary filter names are case sensitive.
Provides information about the specified custom language model.
This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for this failure.
To get a list of your custom language models, use the operation.
", + "GetCallAnalyticsCategory": "Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
", + "GetCallAnalyticsJob": "Provides information about the specified Call Analytics job.
To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.
To get a list of your Call Analytics jobs, use the operation.
", + "GetMedicalTranscriptionJob": "Provides information about the specified medical transcription job.
To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
To get a list of your medical transcription jobs, use the operation.
", + "GetMedicalVocabulary": "Provides information about the specified custom medical vocabulary.
To view the status of the specified medical vocabulary, check the VocabularyState field. If the status is READY, your vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.
To get a list of your custom medical vocabularies, use the operation.
", + "GetTranscriptionJob": "Provides information about the specified transcription job.
To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.
To get a list of your transcription jobs, use the operation.
", + "GetVocabulary": "Provides information about the specified custom vocabulary.
To view the status of the specified vocabulary, check the VocabularyState field. If the status is READY, your vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.
To get a list of your custom vocabularies, use the operation.
", + "GetVocabularyFilter": "Provides information about the specified custom vocabulary filter.
To view the status of the specified vocabulary filter, check the VocabularyState field. If the status is READY, your vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary filter failed.
To get a list of your custom vocabulary filters, use the operation.
", + "ListCallAnalyticsCategories": "Provides a list of Call Analytics categories, including all rules that make up each category.
To get detailed information about a specific Call Analytics category, use the operation.
", + "ListCallAnalyticsJobs": "Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.
To get detailed information about a specific Call Analytics job, use the operation.
", + "ListLanguageModels": "Provides a list of custom language models that match the specified criteria. If no criteria are specified, all language models are returned.
To get detailed information about a specific custom language model, use the operation.
", + "ListMedicalTranscriptionJobs": "Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.
To get detailed information about a specific medical transcription job, use the operation.
", + "ListMedicalVocabularies": "Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.
To get detailed information about a specific custom medical vocabulary, use the operation.
", + "ListTagsForResource": "Lists all tags associated with the specified transcription job, vocabulary, model, or resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "ListTranscriptionJobs": "Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.
To get detailed information about a specific transcription job, use the operation.
", + "ListVocabularies": "Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.
To get detailed information about a specific custom vocabulary, use the operation.
", + "ListVocabularyFilters": "Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.
To get detailed information about a specific custom vocabulary filter, use the operation.
", + "StartCallAnalyticsJob": "Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.
In addition to many of the standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.
If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories.
To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.
You must include the following parameters in your StartCallAnalyticsJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
CallAnalyticsJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.
DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.
Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.
With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.
Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.
In addition to many of the standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.
To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the S3 location of the file using the Media parameter.
You must include the following parameters in your StartMedicalTranscriptionJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.
Media (MediaFileUri): The Amazon S3 location of your media file.
LanguageCode: This must be en-US.
OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.
Specialty: This must be PRIMARYCARE.
Type: Choose whether your audio is a conversation or a dictation.
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.
To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.
You must include the following parameters in your StartTranscriptionJob request:
region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.
Media (MediaFileUri): The Amazon S3 location of your media file.
One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you don't know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "UntagResource": "Removes the specified tags from the specified Amazon Transcribe resource.
If you include UntagResource in your request, you must also include ResourceArn and TagKeys.
Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.
To create a new category, see .
", + "UpdateMedicalVocabulary": "Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing vocabulary.
", + "UpdateVocabulary": "Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing vocabulary.
", + "UpdateVocabularyFilter": "Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing vocabulary filter.
" }, "shapes": { "AbsoluteTimeRange": { - "base": "A time range, set in seconds, between two points in the call.
", + "base": "A time range, in milliseconds, between two points in your media file.
You can use StartTime and EndTime to search a custom segment. For example, setting StartTime to 10000 and EndTime to 50000 only searches for your specified criteria in the audio contained between the 10,000 millisecond mark and the 50,000 millisecond mark of your media file. You must use StartTime and EndTime as a set; that is, if you include one, you must include both.
You can use also First to search from the start of the audio until the time you specify, or Last to search from the time you specify until the end of the audio. For example, setting First to 50000 only searches for your specified criteria in the audio contained between the start of the media file to the 50,000 millisecond mark. You can use First and Last independently of each other.
If you prefer to use percentage instead of milliseconds, see .
", "refs": { - "InterruptionFilter$AbsoluteTimeRange": "An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
", - "NonTalkTimeFilter$AbsoluteTimeRange": "An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.
", - "SentimentFilter$AbsoluteTimeRange": "The time range, measured in seconds, of the sentiment.
", - "TranscriptFilter$AbsoluteTimeRange": "A time range, set in seconds, between two points in the call.
" + "InterruptionFilter$AbsoluteTimeRange": "Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for an interruption. See for more detail.
", + "NonTalkTimeFilter$AbsoluteTimeRange": "Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for a period of silence. See for more detail.
", + "SentimentFilter$AbsoluteTimeRange": "Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified sentiments. See for more detail.
", + "TranscriptFilter$AbsoluteTimeRange": "Allows you to specify a time range (in milliseconds) in your audio, during which you want to search for the specified key words or phrases. See for more detail.
" } }, "BadRequestException": { - "base": "Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's \"in progress\"). See the exception Message field for more information.
Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.
If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.
The Amazon Transcribe standard language model, or base model, you used when creating your custom language model.
If your audio has a sample rate of 16,000 Hz or greater, this value should be WideBand. If your audio has a sample rate of less than 16,000 Hz, this value should be NarrowBand.
The Amazon Transcribe standard language model, or base model used to create the custom language model.
" + "CreateLanguageModelResponse$BaseModelName": "The Amazon Transcribe standard language model, or base model, you specified when creating your custom language model.
", + "LanguageModel$BaseModelName": "The Amazon Transcribe standard language model, or base model, used to create your custom language model.
" } }, "Boolean": { "base": null, "refs": { - "InterruptionFilter$Negate": "Set to TRUE to look for a time period where there was no interruption.
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
Note that job queuing is enabled by default for call analytics jobs.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
Whether the base model used for the custom language model is up to date. If this field is false then you are running the most up-to-date version of the base model in your custom language model.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
Set to TRUE to look for a time period when people were talking.
Set to TRUE to look for sentiments that weren't specified in the request.
Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.
You must include either LanguageCode or IdentifyLanguage in your request.
If TRUE, the rule that you specify is applied to everything except for the phrases that you specify.
A value that shows if automatic language identification was enabled for a transcription job.
", - "TranscriptionJobSummary$IdentifyLanguage": "Whether automatic language identification was enabled for a transcription job.
" + "InterruptionFilter$Negate": "Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains interruptions.
Allows you to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.
Note that job queuing is enabled by default for Call Analytics jobs.
If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.
Shows if a more current base model is available for use with the specified custom language model.
If false, your language model is using the most up-to-date base model.
If true, there is a newer base model available than the one your language model is using.
Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.
", + "MedicalTranscriptionSetting$ShowSpeakerLabels": "Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
For more information, see Identifying speakers (diarization).
", + "MedicalTranscriptionSetting$ChannelIdentification": "Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
For more information, see Transcribing multi-channel audio.
", + "MedicalTranscriptionSetting$ShowAlternatives": "To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate.
For more information, see Alternative transcriptions.
", + "NonTalkTimeFilter$Negate": "Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence
Set to TRUE to flag the sentiments you didn't include in your request. Set to FALSE to flag the sentiments you specified in your request.
Enables speaker identification (diarization) in your transcription output. Speaker identification labels the speech from individual speakers in your media file.
If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
For more information, see Identifying speakers (diarization).
", + "Settings$ChannelIdentification": "Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
For more information, see Transcribing multi-channel audio.
", + "Settings$ShowAlternatives": "To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative transcriptions.
", + "StartTranscriptionJobRequest$IdentifyLanguage": "Enables automatic language identification in your transcription job request.
If you include IdentifyLanguage, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including language options can improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).
Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
Enables automatic multi-language identification in your transcription job request. Use this parameter if your media file contains more than one language.
If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your media file. Including language options can improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic language identification request, include LanguageIdSettings with the relevant sub-parameters (VocabularyName and VocabularyFilterName).
Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
Set to TRUE to flag the absence of the phrase you specified in your request. Set to FALSE to flag the presence of the phrase you specified in your request.
Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.
Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.
Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.
Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.
The language of your custom language model; note that the language code you select must match the language of your training and tuning data.
", + "CreateLanguageModelRequest$LanguageCode": "The language code that represents the language of your model. Each language model must contain terms in only one language, and the language you select for your model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a language model using US English (en-US), you can only apply this model to files that contain English audio.
The language code you selected for your custom language model.
", - "LanguageModel$LanguageCode": "The language code you used to create your custom language model.
" + "LanguageModel$LanguageCode": "The language code used to create your custom language model. Each language model must contain terms in only one language, and the language you select for your model must match the language of your training and tuning data.
For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
Describes an asynchronous analytics job that was created with the StartAnalyticsJob operation.
Provides detailed information about a Call Analytics job.
To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.
If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in the RedactedMediaFileUri field of your response.
An object that contains detailed information about your call analytics job. Returned fields include: CallAnalyticsJobName, CallAnalyticsJobStatus, ChannelDefinitions, CompletionTime, CreationTime, DataAccessRoleArn, FailureReason, IdentifiedLanguageScore, LanguageCode, Media, MediaFormat, MediaSampleRateHertz, Settings, StartTime, and Transcript.
An object containing the details of the asynchronous call analytics job.
" + "GetCallAnalyticsJobResponse$CallAnalyticsJob": "Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.
", + "StartCallAnalyticsJobResponse$CallAnalyticsJob": "Provides detailed information about the current Call Analytics job, including job status and, if applicable, failure reason.
" } }, "CallAnalyticsJobName": { "base": null, "refs": { - "CallAnalyticsJob$CallAnalyticsJobName": "The name of the call analytics job.
", - "CallAnalyticsJobSummary$CallAnalyticsJobName": "The name of the call analytics job.
", - "DeleteCallAnalyticsJobRequest$CallAnalyticsJobName": "The name of the call analytics job you want to delete. Job names are case-sensitive.
", - "GetCallAnalyticsJobRequest$CallAnalyticsJobName": "The name of the analytics job you want information about. This value is case sensitive.
", - "ListCallAnalyticsJobsRequest$JobNameContains": "When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
", - "StartCallAnalyticsJobRequest$CallAnalyticsJobName": "The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same name as a previous call analytics job, you get a ConflictException error.
The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
", + "CallAnalyticsJobSummary$CallAnalyticsJobName": "The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.
", + "DeleteCallAnalyticsJobRequest$CallAnalyticsJobName": "The name of the Call Analytics job you want to delete. Job names are case sensitive.
", + "GetCallAnalyticsJobRequest$CallAnalyticsJobName": "The name of the Call Analytics job you want information about. Job names are case sensitive.
", + "ListCallAnalyticsJobsRequest$JobNameContains": "Returns only the Call Analytics jobs that contain the specified string. The search is not case sensitive.
", + "StartCallAnalyticsJobRequest$CallAnalyticsJobName": "A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
Provides optional settings for the CallAnalyticsJob operation.
Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, vocabulary filters, and custom vocabularies.
", "refs": { - "CallAnalyticsJob$Settings": "Provides information about the settings used to run a transcription job.
", - "StartCallAnalyticsJobRequest$Settings": "A Settings object that provides optional settings for a call analytics job.
Allows additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
", + "StartCallAnalyticsJobRequest$Settings": "Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.
" } }, "CallAnalyticsJobStatus": { "base": null, "refs": { - "CallAnalyticsJob$CallAnalyticsJobStatus": "The status of the analytics job.
", - "CallAnalyticsJobSummary$CallAnalyticsJobStatus": "The status of the call analytics job.
", - "ListCallAnalyticsJobsRequest$Status": "When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.
", - "ListCallAnalyticsJobsResponse$Status": "When specified, returns only call analytics jobs with that status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
" + "CallAnalyticsJob$CallAnalyticsJobStatus": "Provides the status of the specified Call Analytics job.
If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
Provides the status of your Call Analytics job.
If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.
Lists all Call Analytics jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
" } }, "CallAnalyticsJobSummaries": { "base": null, "refs": { - "ListCallAnalyticsJobsResponse$CallAnalyticsJobSummaries": "A list of objects containing summary information for a transcription job.
" + "ListCallAnalyticsJobsResponse$CallAnalyticsJobSummaries": "Provides a summary of information about each result.
" } }, "CallAnalyticsJobSummary": { - "base": "Provides summary information about a call analytics job.
", + "base": "Provides detailed information about a specific Call Analytics job.
", "refs": { "CallAnalyticsJobSummaries$member": null } @@ -142,30 +145,30 @@ "CategoryName": { "base": null, "refs": { - "CategoryProperties$CategoryName": "The name of the call analytics category.
", - "CreateCallAnalyticsCategoryRequest$CategoryName": "A unique name, chosen by you, for your call analytics category. For example, sentiment-positive-last30seconds.
The name of the call analytics category you want to delete. Category names are case-sensitive.
", - "GetCallAnalyticsCategoryRequest$CategoryName": "The name of the category you want information about. Category names are case sensitive.
", - "UpdateCallAnalyticsCategoryRequest$CategoryName": "The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics category with the same name as a previous category you will receive a ConflictException error.
The name of the Call Analytics category. Category names are case sensitive and must be unique within an Amazon Web Services account.
", + "CreateCallAnalyticsCategoryRequest$CategoryName": "A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds for a category over a generic name like test-category.
Category names are case sensitive.
", + "DeleteCallAnalyticsCategoryRequest$CategoryName": "The name of the Call Analytics category you want to delete. Category names are case sensitive.
", + "GetCallAnalyticsCategoryRequest$CategoryName": "The name of the Call Analytics category you want information about. Category names are case sensitive.
", + "UpdateCallAnalyticsCategoryRequest$CategoryName": "The name of the Call Analytics category you want to update. Category names are case sensitive.
" } }, "CategoryProperties": { - "base": "An object that contains the rules and additional information about a call analytics category.
", + "base": "Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.
", "refs": { "CategoryPropertiesList$member": null, - "CreateCallAnalyticsCategoryResponse$CategoryProperties": "If your audio matches one of your categories, this field contains data on that category and its associated rules. This parameter shows which category is flagged (CategoryName) along with metadata for the rules that match your audio. Metadata includes the rule filter (such as InterruptionFilter, NonTalkTimeFilter, SentimentFilter, and TranscriptFilter) and where in your audio (StartTime and EndTime) the rule has a match.
Provides you with the rules associated with the category you specified in your GetCallAnalyticsCategory request.
The attributes describing the analytics category. You can see information such as the rules that you've used to update the category and when the category was originally created.
" + "CreateCallAnalyticsCategoryResponse$CategoryProperties": "Provides you with the properties of your new category, including its associated rules.
", + "GetCallAnalyticsCategoryResponse$CategoryProperties": "Provides you with the properties of the Call Analytics category you specified in your GetCallAnalyticsCategory request.
Provides you with the properties of the Call Analytics category you specified in your UpdateCallAnalyticsCategory request.
A list of objects containing information about analytics categories.
" + "ListCallAnalyticsCategoriesResponse$Categories": "Provides detailed information about your Call Analytics categories, including all the rules associated with each category.
" } }, "ChannelDefinition": { - "base": "For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
", + "base": "Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).
Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the customer's audio.
", - "StartCallAnalyticsJobRequest$ChannelDefinitions": "When you start a call analytics job, you must pass an array that maps the agent and the customer to specific audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have their own channel. You can't assign more than one channel to an agent or customer.
" + "CallAnalyticsJob$ChannelDefinitions": "Allows you to specify which speaker is on which channel in your Call Analytics job request. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).
Allows you to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).
A value that indicates the audio channel.
" + "ChannelDefinition$ChannelId": "Specify the audio channel you want to define.
" } }, "ConflictException": { - "base": "There is already a resource with that name.
", + "base": "A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
", "refs": { } }, "ContentRedaction": { - "base": "Settings for content redaction within a transcription job.
", + "base": "Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.
An object that contains the request parameters for content redaction.
", - "TranscriptionJob$ContentRedaction": "An object that describes content redaction settings for the transcription job.
", + "StartTranscriptionJobRequest$ContentRedaction": "Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.
Redacts or flags specified personally identifiable information (PII) in your transcript.
", "TranscriptionJobSummary$ContentRedaction": "The content redaction settings of the transcription job.
" } }, @@ -250,48 +253,48 @@ "DataAccessRoleArn": { "base": null, "refs": { - "CallAnalyticsJob$DataAccessRoleArn": "The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
The Amazon Resource Name (ARN), in the form arn:partition:service:region:account-id:resource-type/resource-id, of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription results, this role should have access to the output bucket as well.
" + "CallAnalyticsJob$DataAccessRoleArn": "The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
", + "InputDataConfig$DataAccessRoleArn": "The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
", + "JobExecutionSettings$DataAccessRoleArn": "The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.
The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.
IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
" } }, "DateTime": { "base": null, "refs": { - "CallAnalyticsJob$StartTime": "A timestamp that shows when the analytics job started processing.
", - "CallAnalyticsJob$CreationTime": "A timestamp that shows when the analytics job was created.
", - "CallAnalyticsJob$CompletionTime": "A timestamp that shows when the analytics job was completed.
", - "CallAnalyticsJobSummary$CreationTime": "A timestamp that shows when the call analytics job was created.
", - "CallAnalyticsJobSummary$StartTime": "A timestamp that shows when the job began processing.
", - "CallAnalyticsJobSummary$CompletionTime": "A timestamp that shows when the job was completed.
", - "CategoryProperties$CreateTime": "A timestamp that shows when the call analytics category was created.
", - "CategoryProperties$LastUpdateTime": "A timestamp that shows when the call analytics category was most recently updated.
", - "CreateMedicalVocabularyResponse$LastModifiedTime": "The date and time you created your custom medical vocabulary.
", - "CreateVocabularyFilterResponse$LastModifiedTime": "The date and time the vocabulary filter was modified.
", - "CreateVocabularyResponse$LastModifiedTime": "The date and time you created your custom vocabulary.
", - "GetMedicalVocabularyResponse$LastModifiedTime": "The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
", - "GetVocabularyFilterResponse$LastModifiedTime": "The date and time that the contents of the vocabulary filter were updated.
", - "GetVocabularyResponse$LastModifiedTime": "The date and time that the vocabulary was last modified.
", - "LanguageModel$CreateTime": "The time the custom language model was created.
", - "LanguageModel$LastModifiedTime": "The most recent time the custom language model was modified.
", - "MedicalTranscriptionJob$StartTime": "A timestamp that shows when the job started processing.
", - "MedicalTranscriptionJob$CreationTime": "A timestamp that shows when the job was created.
", - "MedicalTranscriptionJob$CompletionTime": "A timestamp that shows when the job was completed.
", - "MedicalTranscriptionJobSummary$CreationTime": "A timestamp that shows when the medical transcription job was created.
", - "MedicalTranscriptionJobSummary$StartTime": "A timestamp that shows when the job began processing.
", - "MedicalTranscriptionJobSummary$CompletionTime": "A timestamp that shows when the job was completed.
", - "TranscriptionJob$StartTime": "A timestamp that shows when the job started processing.
", - "TranscriptionJob$CreationTime": "A timestamp that shows when the job was created.
", - "TranscriptionJob$CompletionTime": "A timestamp that shows when the job completed.
", - "TranscriptionJobSummary$CreationTime": "A timestamp that shows when the job was created.
", - "TranscriptionJobSummary$StartTime": "A timestamp that shows when the job started processing.
", - "TranscriptionJobSummary$CompletionTime": "A timestamp that shows when the job was completed.
", - "UpdateMedicalVocabularyResponse$LastModifiedTime": "The date and time that the vocabulary was updated.
", - "UpdateVocabularyFilterResponse$LastModifiedTime": "The date and time that the vocabulary filter was updated.
", - "UpdateVocabularyResponse$LastModifiedTime": "The date and time that the vocabulary was updated.
", - "VocabularyFilterInfo$LastModifiedTime": "The date and time that the vocabulary was last updated.
", - "VocabularyInfo$LastModifiedTime": "The date and time that the vocabulary was last modified.
" + "CallAnalyticsJob$StartTime": "The date and time the specified Call Analytics job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your Call Analytics job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics category was created.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified Call Analytics category was last updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.
The date and time you created your custom medical vocabulary.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time you created your vocabulary filter.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time you created your custom vocabulary.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified custom medical vocabulary was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified vocabulary filter was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified vocabulary was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified custom language model was created.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified language model was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your medical transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified medical transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job request was made.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time your transcription job began processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified transcription job finished processing.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
The date and time the specified custom medical vocabulary was last updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified vocabulary filter was last updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified vocabulary was last updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified vocabulary filter was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
The date and time the specified vocabulary was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
Provides the total time, in seconds, each identified language is spoken in your media.
" + } + }, "FailureReason": { "base": null, "refs": { "BadRequestException$Message": null, - "CallAnalyticsJob$FailureReason": "If the AnalyticsJobStatus is FAILED, this field contains information about why the job failed.
The FailureReason field can contain one of the following values:
Unsupported media format: The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format: The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.
Invalid sample rate for audio file: The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate: The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large: The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide.
Invalid number of channels: number of channels too large: Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
If the CallAnalyticsJobStatus is FAILED, a description of the error.
If the VocabularyState field is FAILED, FailureReason contains information about why the job failed.
If the VocabularyState field is FAILED, FailureReason contains information about why the job failed.
If your request returns a VocabularyState that is FAILED, the FailureReason field contains information about why the request failed.
For more information, refer to the Common Errors section.
", - "GetVocabularyResponse$FailureReason": "If the VocabularyState field is FAILED, this field contains information about why the job failed.
The reason why the custom language model couldn't be created.
", - "MedicalTranscriptionJob$FailureReason": "If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
The FailureReason field contains one of the following values:
Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match.
Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide.
Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
If the TranscriptionJobStatus field is FAILED, a description of the error.
If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
The FailureReason field can contain one of the following values:
Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
If the TranscriptionJobStatus field is FAILED, a description of the error.
If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.
The FailureReason field contains one of the following values:
Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.
The media format provided does not match the detected media format.
The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.
Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate.
The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.
If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job request failed. See also: Common Errors.
If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed. See also: Common Errors.
If VocabularyState is FAILED, FailureReason contains information about why the medical vocabulary request failed. See also: Common Errors.
If VocabularyState is FAILED, FailureReason contains information about why the vocabulary request failed. See also: Common Errors.
If ModelStatus is FAILED, FailureReason contains information about why the custom language model request failed. See also: Common Errors.
If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
The FailureReason field contains one of the following values:
Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.
The media format provided does not match the detected media format.
The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.
Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate.
The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
The FailureReason field contains one of the following values:
Unsupported media format.
The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.
The media format provided does not match the detected media format.
The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.
Invalid sample rate for audio file.
The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
The sample rate provided does not match the detected sample rate.
The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
Invalid file size: file size too large.
The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
Invalid number of channels: number of channels too large.
Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in the language that it identified.
", - "TranscriptionJob$IdentifiedLanguageScore": "A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
", - "TranscriptionJobSummary$IdentifiedLanguageScore": "A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it identified.
" + "CallAnalyticsJob$IdentifiedLanguageScore": "The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
", + "TranscriptionJob$IdentifiedLanguageScore": "The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
", + "TranscriptionJobSummary$IdentifiedLanguageScore": "The confidence score associated with the language identified in your media file.
Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.
" } }, "InputDataConfig": { - "base": "The object that contains the Amazon S3 object location and access role required to train and tune your custom language model.
", + "base": "Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.
When using InputDataConfig, you must include these sub-parameters: S3Uri and DataAccessRoleArn. You can optionally include TuningDataS3Uri.
Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 locations of your training (S3Uri) and tuning (TuningDataS3Uri) data.
Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations your provided for your training (S3Uri) and tuning (TuningDataS3Uri) data.
The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
" + "CreateLanguageModelRequest$InputDataConfig": "Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.
When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.
Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) data.
The Amazon S3 location of the input files used to train and tune your custom language model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to access these data.
" } }, "InternalFailureException": { - "base": "There was an internal error. Check the error message and try your request again.
", + "base": "There was an internal error. Check the error message, correct the issue, and try your request again.
", "refs": { } }, "InterruptionFilter": { - "base": "An object that enables you to configure your category to be applied to call analytics jobs where either the customer or agent was interrupted.
", + "base": "Flag the presence or absence of interruptions in your Call Analytics transcription output.
Rules using InterruptionFilter are designed to match:
Instances where an agent interrupts a customer
Instances where a customer interrupts an agent
Either participant interrupting the other
A lack of interruptions
See Rule criteria for usage examples.
", "refs": { - "Rule$InterruptionFilter": "A condition for a time period when either the customer or agent was interrupting the other person.
" + "Rule$InterruptionFilter": "Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.
" } }, "JobExecutionSettings": { - "base": "Provides information about when a transcription job should be executed.
", + "base": "Allows you to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.
Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
", - "TranscriptionJob$JobExecutionSettings": "Provides information about how a transcription job is executed.
" + "StartTranscriptionJobRequest$JobExecutionSettings": "Allows you to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.
If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.
Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used.
" } }, "KMSEncryptionContextMap": { "base": null, "refs": { - "StartMedicalTranscriptionJobRequest$KMSEncryptionContext": "A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
", - "StartTranscriptionJobRequest$KMSEncryptionContext": "A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
" + "StartMedicalTranscriptionJobRequest$KMSEncryptionContext": "A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
", + "StartTranscriptionJobRequest$KMSEncryptionContext": "A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
" } }, "KMSKeyId": { "base": null, "refs": { - "StartCallAnalyticsJobRequest$OutputEncryptionKMSKeyId": "The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt the output of the call analytics job. The user calling the operation must have permission to use the specified KMS key.
You use either of the following to identify an Amazon Web Services KMS key in the current account:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
KMS Key Alias: \"alias/ExampleAlias\"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS key in the current account or another account: \"arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab\"
ARN of a KMS Key Alias: \"arn:aws:kms:region:accountID:alias/ExampleAlias\"
If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputLocation parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
KMS Key Alias: \"alias/ExampleAlias\"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS key in the current account or another account: \"arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ARN of a KMS Key Alias: \"arn:aws:kms:region:account ID:alias/ExampleAlias\"
If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.
You can use either of the following to identify a KMS key in the current account:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
KMS Key Alias: \"alias/ExampleAlias\"
You can use either of the following to identify a KMS key in the current account or another account:
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
ARN of a KMS Key Alias: \"arn:aws:kms:region:account-ID:alias/ExampleAlias\"
If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
", + "StartMedicalTranscriptionJobRequest$OutputEncryptionKMSKeyId": "The KMS key you want to use to encrypt your medical transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
", + "StartTranscriptionJobRequest$OutputEncryptionKMSKeyId": "The KMS key you want to use to encrypt your transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Use an alias for the KMS key ID. For example, alias/ExampleAlias.
Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
" } }, "LanguageCode": { "base": null, "refs": { - "CallAnalyticsJob$LanguageCode": "If you know the language spoken between the customer and the agent, specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages for additional information.
", - "CallAnalyticsJobSummary$LanguageCode": "The language of the transcript in the source audio file.
", - "CreateMedicalVocabularyRequest$LanguageCode": "The language code that represents the language of the entries in your custom vocabulary. Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code you selected for your medical vocabulary. Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
", - "CreateVocabularyFilterResponse$LanguageCode": "The language code associated with your vocabulary filter.
", - "CreateVocabularyRequest$LanguageCode": "The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.
", - "CreateVocabularyResponse$LanguageCode": "The language code you selected for your vocabulary.
", - "GetMedicalVocabularyResponse$LanguageCode": "The valid language code for your vocabulary entries.
", - "GetVocabularyFilterResponse$LanguageCode": "The language code of the words in the vocabulary filter.
", - "GetVocabularyResponse$LanguageCode": "The language code of the vocabulary entries.
", + "CallAnalyticsJob$LanguageCode": "The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
", + "CallAnalyticsJobSummary$LanguageCode": "The language code used to create your Call Analytics transcription.
", + "CreateMedicalVocabularyRequest$LanguageCode": "The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
", + "CreateVocabularyFilterResponse$LanguageCode": "The language code you selected for your vocabulary filter.
", + "CreateVocabularyRequest$LanguageCode": "The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
", + "CreateVocabularyResponse$LanguageCode": "The language code you selected for your custom vocabulary.
", + "GetMedicalVocabularyResponse$LanguageCode": "The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code you selected for your vocabulary filter.
", + "GetVocabularyResponse$LanguageCode": "The language code you selected for your custom vocabulary.
", + "LanguageCodeItem$LanguageCode": "Provides the language code for each language identified in your media.
", "LanguageIdSettingsMap$key": null, "LanguageOptions$member": null, - "MedicalTranscriptionJob$LanguageCode": "The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
The language of the transcript in the source audio file.
", - "StartMedicalTranscriptionJobRequest$LanguageCode": "The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
The language code for the language used in the input media file. You must include either LanguageCode or IdentifyLanguage in your request.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
", - "TranscriptionJob$LanguageCode": "The language code for the input speech.
", - "TranscriptionJobSummary$LanguageCode": "The language code for the input speech.
", - "UpdateMedicalVocabularyRequest$LanguageCode": "The language code of the language used for the entries in the updated vocabulary. U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.
", - "UpdateMedicalVocabularyResponse$LanguageCode": "The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
", - "UpdateVocabularyFilterResponse$LanguageCode": "The language code of the words in the vocabulary filter.
", - "UpdateVocabularyRequest$LanguageCode": "The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see Supported languages.
", - "UpdateVocabularyResponse$LanguageCode": "The language code of the vocabulary entries.
", - "VocabularyFilterInfo$LanguageCode": "The language code of the words in the vocabulary filter.
", - "VocabularyInfo$LanguageCode": "The language code of the vocabulary entries.
" + "MedicalTranscriptionJob$LanguageCode": "The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.
The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.
The language code that represents the language spoken in the input media file. US English (en-US) is the only valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
The language code that represents the language spoken in the input media file.
If you're unsure of the language spoken in your media file, consider using IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
The language code used to create your transcription.
", + "UpdateMedicalVocabularyRequest$LanguageCode": "The language code that represents the language of the entries in the custom vocabulary you want to update. US English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code you selected for your medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
The language code you selected for your vocabulary filter.
", + "UpdateVocabularyRequest$LanguageCode": "The language code that represents the language of the entries in the custom vocabulary you want to update. Each vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
", + "UpdateVocabularyResponse$LanguageCode": "The language code you selected for your custom vocabulary.
", + "VocabularyFilterInfo$LanguageCode": "The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.
A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
", + "VocabularyInfo$LanguageCode": "The language code used to create your custom vocabulary. Each vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary to files that contain English audio.
Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.
", + "refs": { + "LanguageCodeList$member": null + } + }, + "LanguageCodeList": { + "base": null, + "refs": { + "TranscriptionJob$LanguageCodes": "The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
", + "TranscriptionJobSummary$LanguageCodes": "The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.
Language-specific settings that can be specified when language identification is enabled.
", + "base": "If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).
You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.
If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
The language identification settings associated with your call analytics job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.
If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).
You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.
If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).
You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.
If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName).
You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters.
To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification.
If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
The structure used to describe a custom language model.
", + "base": "Provides information about a custom language model, including the base model name, when the model was created, the location of the files used to train the model, when the model was last modified, the name you chose for the model, its language, its processing state, and if there is an upgrade available for the base model.
", "refs": { - "DescribeLanguageModelResponse$LanguageModel": "The name of the custom language model you requested more information about.
", + "DescribeLanguageModelResponse$LanguageModel": "Provides information about the specified custom language model.
This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use this DescribeLanguageModel to help identify the reason for this failure.
When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify the language for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages for additional information.
", - "StartTranscriptionJobRequest$LanguageOptions": "An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
", - "TranscriptionJob$LanguageOptions": "An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
" + "CallAnalyticsJobSettings$LanguageOptions": "You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
Including language options can improve the accuracy of language identification.
For a list of languages supported with Call Analytics, refer to the Supported languages table.
", + "StartTranscriptionJobRequest$LanguageOptions": "You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
If you include LanguageOptions in your request, you must also include IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.
If you include LanguageOptions in your request, you must also include IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher.
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
", + "base": "You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
", "refs": { } }, @@ -648,161 +671,161 @@ "MaxAlternatives": { "base": null, "refs": { - "MedicalTranscriptionSetting$MaxAlternatives": "The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
For more information, see Alternative transcriptions.
", + "Settings$MaxAlternatives": "Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.
For more information, see Alternative transcriptions.
" } }, "MaxResults": { "base": null, "refs": { - "ListCallAnalyticsCategoriesRequest$MaxResults": "The maximum number of categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListCallAnalyticsJobsRequest$MaxResults": "The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListLanguageModelsRequest$MaxResults": "The maximum number of language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListMedicalTranscriptionJobsRequest$MaxResults": "The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListMedicalVocabulariesRequest$MaxResults": "The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListTranscriptionJobsRequest$MaxResults": "The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListVocabulariesRequest$MaxResults": "The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
", - "ListVocabularyFiltersRequest$MaxResults": "The maximum number of filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.
" + "ListCallAnalyticsCategoriesRequest$MaxResults": "The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListCallAnalyticsJobsRequest$MaxResults": "The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListLanguageModelsRequest$MaxResults": "The maximum number of custom language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListMedicalTranscriptionJobsRequest$MaxResults": "The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListMedicalVocabulariesRequest$MaxResults": "The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListTranscriptionJobsRequest$MaxResults": "The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListVocabulariesRequest$MaxResults": "The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
", + "ListVocabularyFiltersRequest$MaxResults": "The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
" } }, "MaxSpeakers": { "base": null, "refs": { - "MedicalTranscriptionSetting$MaxSpeakerLabels": "The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
Specify the maximum number of speakers you want to identify in your media.
Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
Specify the maximum number of speakers you want to identify in your media.
Note that if your media contains more speakers than the specified number, multiple speakers will be identified as a single speaker.
If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
Describes the input media file in a transcription request.
", + "base": "Describes the Amazon S3 location of the media file you want to use in your request.
", "refs": { "CallAnalyticsJob$Media": null, "MedicalTranscriptionJob$Media": null, "StartCallAnalyticsJobRequest$Media": null, "StartMedicalTranscriptionJobRequest$Media": null, - "StartTranscriptionJobRequest$Media": "An object that describes the input media for a transcription job.
", - "TranscriptionJob$Media": "An object that describes the input media for the transcription job.
" + "StartTranscriptionJobRequest$Media": "Describes the Amazon S3 location of the media file you want to use in your request.
", + "TranscriptionJob$Media": "Describes the Amazon S3 location of the media file you want to use in your request.
" } }, "MediaFormat": { "base": null, "refs": { - "CallAnalyticsJob$MediaFormat": "The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.
", + "CallAnalyticsJob$MediaFormat": "The format of the input media file.
", "MedicalTranscriptionJob$MediaFormat": "The format of the input media file.
", - "StartMedicalTranscriptionJobRequest$MediaFormat": "The audio format of the input media file.
", - "StartTranscriptionJobRequest$MediaFormat": "The format of the input media file.
", + "StartMedicalTranscriptionJobRequest$MediaFormat": "Specify the format of your input media file.
", + "StartTranscriptionJobRequest$MediaFormat": "Specify the format of your input media file.
", "TranscriptionJob$MediaFormat": "The format of the input media file.
" } }, "MediaSampleRateHertz": { "base": null, "refs": { - "CallAnalyticsJob$MediaSampleRateHertz": "The sample rate, in Hertz, of the input audio.
", - "StartTranscriptionJobRequest$MediaSampleRateHertz": "The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
The sample rate, in Hertz (Hz), of the audio track in the input media file.
" + "CallAnalyticsJob$MediaSampleRateHertz": "The sample rate, in Hertz, of the audio track in your input media file.
", + "StartTranscriptionJobRequest$MediaSampleRateHertz": "The sample rate, in Hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe; if there's a mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
The sample rate, in Hertz, of the audio track in your input media file.
" } }, "MedicalContentIdentificationType": { "base": null, "refs": { - "MedicalTranscriptionJob$ContentIdentificationType": "Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the job to identify personal health information (PHI) in the transcription output.
Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the transcription job to identify personal health information (PHI).
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
", + "MedicalTranscriptionJobSummary$ContentIdentificationType": "Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
", + "StartMedicalTranscriptionJobRequest$ContentIdentificationType": "Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
" } }, "MedicalMediaSampleRateHertz": { "base": null, "refs": { - "MedicalTranscriptionJob$MediaSampleRateHertz": "The sample rate, in Hertz, of the source audio containing medical information.
If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.
", - "StartMedicalTranscriptionJobRequest$MediaSampleRateHertz": "The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
The sample rate, in Hertz, of the audio track in your input media file.
", + "StartMedicalTranscriptionJobRequest$MediaSampleRateHertz": "The sample rate, in Hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
Identifies the location of a medical transcript.
", + "base": "Provides you with the Amazon S3 URI you can use to access your transcript.
", "refs": { - "MedicalTranscriptionJob$Transcript": "An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
Provides you with the Amazon S3 URI you can use to access your transcript.
" } }, "MedicalTranscriptionJob": { - "base": "The data structure that contains the information for a medical transcription job.
", + "base": "Provides detailed information about a medical transcription job.
To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
An object that contains detailed information about your medical transcription job. Returned fields include: CompletionTime, ContentIdentificationType, CreationTime, FailureReason, LanguageCode, Media, MediaFormat, MediaSampleRateHertz, MedicalTranscriptionJobName, Settings, Specialty, StartTime, Tags, Transcript, TranscriptionJobStatus, and Type.
A batch job submitted to transcribe medical speech to text.
" + "GetMedicalTranscriptionJobResponse$MedicalTranscriptionJob": "Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason.
", + "StartMedicalTranscriptionJobResponse$MedicalTranscriptionJob": "Provides detailed information about the current medical transcription job, including job status and, if applicable, failure reason.
" } }, "MedicalTranscriptionJobSummaries": { "base": null, "refs": { - "ListMedicalTranscriptionJobsResponse$MedicalTranscriptionJobSummaries": "A list of objects containing summary information for a transcription job.
" + "ListMedicalTranscriptionJobsResponse$MedicalTranscriptionJobSummaries": "Provides a summary of information about each result.
" } }, "MedicalTranscriptionJobSummary": { - "base": "Provides summary information about a transcription job.
", + "base": "Provides detailed information about a specific medical transcription job.
", "refs": { "MedicalTranscriptionJobSummaries$member": null } }, "MedicalTranscriptionSetting": { - "base": "Optional settings for the StartMedicalTranscriptionJob operation.
", + "base": "Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.
", "refs": { - "MedicalTranscriptionJob$Settings": "Object that contains object.
", - "StartMedicalTranscriptionJobRequest$Settings": "Optional settings for the medical transcription job.
" + "MedicalTranscriptionJob$Settings": "Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your medical transcription job.
", + "StartMedicalTranscriptionJobRequest$Settings": "Specify additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
" } }, "ModelName": { "base": null, "refs": { - "CallAnalyticsJobSettings$LanguageModelName": "The structure used to describe a custom language model.
", - "CreateLanguageModelRequest$ModelName": "The name of your new custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a language model with the same name as a previous language model, you get a ConflictException error.
The unique name you chose for your custom language model.
", - "DeleteLanguageModelRequest$ModelName": "The name of the model you want to delete. Model names are case-sensitive.
", - "DescribeLanguageModelRequest$ModelName": "The name of the custom language model you want described. Model names are case-sensitive.
", - "LanguageIdSettings$LanguageModelName": "The name of the language model you want to use when transcribing your audio. The model you specify must have the same language codes as the transcription job; if the languages don't match, the language model isn't be applied.
", - "LanguageModel$ModelName": "The name of the custom language model.
", - "ListLanguageModelsRequest$NameContains": "When specified, the custom language model names returned contain the substring you've specified.
", - "ModelSettings$LanguageModelName": "The name of your custom language model.
" + "CallAnalyticsJobSettings$LanguageModelName": "The name of the custom language model you want to use when processing your Call Analytics job. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
", + "CreateLanguageModelRequest$ModelName": "A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new language model with the same name as an existing language model, you get a ConflictException error.
The name of your custom language model.
", + "DeleteLanguageModelRequest$ModelName": "The name of the custom language model you want to delete. Model names are case sensitive.
", + "DescribeLanguageModelRequest$ModelName": "The name of the custom language model you want information about. Model names are case sensitive.
", + "LanguageIdSettings$LanguageModelName": "The name of the custom language model you want to use when processing your transcription job. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
", + "LanguageModel$ModelName": "A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
", + "ListLanguageModelsRequest$NameContains": "Returns only the custom language models that contain the specified string. The search is not case sensitive.
", + "ModelSettings$LanguageModelName": "The name of the custom language model you want to use when processing your transcription job. Note that language model names are case sensitive.
The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the language model isn't applied. There are no errors or warnings associated with a language mismatch.
" } }, "ModelSettings": { - "base": "The object used to call your custom language model to your transcription job.
", + "base": "Provides the name of the custom language model that was included in the specified transcription job.
Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.
Choose the custom language model you use for your transcription job in this parameter.
", - "TranscriptionJob$ModelSettings": "An object containing the details of your custom language model.
", + "StartTranscriptionJobRequest$ModelSettings": "Specify the custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.
For more information, see Custom language models.
", + "TranscriptionJob$ModelSettings": "The custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter.
The status of your custom language model. When the status shows as COMPLETED, your model is ready to use.
The creation status of a custom language model. When the status is COMPLETED the model is ready for use.
When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.
" + "CreateLanguageModelResponse$ModelStatus": "The status of your custom language model. When the status displays as COMPLETED, your model is ready to use.
The status of the specified custom language model. When the status displays as COMPLETED the model is ready for use.
Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.
A list of objects containing information about custom language models.
" + "ListLanguageModelsResponse$Models": "Provides information about the custom language models that match the criteria specified in your request.
" } }, "NextToken": { "base": null, "refs": { - "ListCallAnalyticsCategoriesRequest$NextToken": "When included, NextTokenfetches the next set of categories if the result of the previous request was truncated.
The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more categories in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the operation to return the next page of analytics categories.
If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.
The operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in your next request to the operation to return next page of jobs.
When included, fetches the next set of jobs if the result of the previous request was truncated.
", - "ListLanguageModelsResponse$NextToken": "The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the operation to return the next page of language models.
If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.
The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, include the token in the next request to the ListMedicalVocabularies operation.
If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.
The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.
If the result of the previous request to ListVocabularyFilters was truncated, include the NextToken to fetch the next set of collections.
The ListVocabularyFilters operation returns a page of collections at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularyFilters operation to return in the next page of jobs.
If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListCallAnalyticsJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListMedicalTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListMedicalVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListTranscriptionJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
If your ListVocabularyFilters request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
An object that enables you to configure your category to be applied to call analytics jobs where either the customer or agent was interrupted.
", + "base": "Flag the presence or absence of periods of silence in your Call Analytics transcription output.
Rules using NonTalkTimeFilter are designed to match:
The presence of silence at specified periods throughout the call
The presence of speech at specified periods throughout the call
See Rule criteria for usage examples.
", "refs": { - "Rule$NonTalkTimeFilter": "A condition for a time period when neither the customer nor the agent was talking.
" + "Rule$NonTalkTimeFilter": "Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.
" } }, "NotFoundException": { - "base": "We can't find the requested resource. Check the name and try your request again.
", + "base": "We can't find the requested resource. Check that the specified name is correct and try your request again.
", "refs": { } }, "OutputBucketName": { "base": null, "refs": { - "StartMedicalTranscriptionJobRequest$OutputBucketName": "The Amazon S3 location where the transcription is stored.
You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
The location where the transcription is stored.
If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket.
For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is \"your-transcription-job-name.json\".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key would lead to the output being stored as \"folder1/folder2/your-transcription-job-name.json\". If you specify \"my-other-job-name.json\" as the output key, the object key is changed to \"my-other-job-name.json\". You can use an output key to change both the prefix and the file name, for example \"folder/my-other-job-name.json\".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
You can specify a location in an Amazon S3 bucket to store the output of your transcription job.
If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is \"your-transcription-job-name.json\".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key would lead to the output being stored as \"folder1/folder2/your-transcription-job-name.json\". If you specify \"my-other-job-name.json\" as the output key, the object key is changed to \"my-other-job-name.json\". You can use an output key to change both the prefix and the file name, for example \"folder/my-other-job-name.json\".
If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your medical transcription job (MedicalTranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
", + "StartTranscriptionJobRequest$OutputKey": "Use in combination with OutputBucketName to specify the output location of your transcript and, optionally, a unique name for your output file. The default name for your transcription output is the same as the name you specified for your transcription job (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
If you specify 'my-first-transcription' as the TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
" } }, "OutputLocationType": { "base": null, "refs": { - "MedicalTranscriptionJobSummary$OutputLocationType": "Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.
", - "TranscriptionJobSummary$OutputLocationType": "Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.
If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.
Indicates where the specified medical transcription output is stored.
If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri field.
Indicates where the specified transcription output is stored.
If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.
Indicates whether the person speaking on the audio channel is the agent or customer.
", - "InterruptionFilter$ParticipantRole": "Indicates whether the caller or customer was interrupting.
", - "SentimentFilter$ParticipantRole": "A value that determines whether the sentiment belongs to the customer or the agent.
", - "TranscriptFilter$ParticipantRole": "Determines whether the customer or the agent is speaking the phrases that you've specified.
" + "ChannelDefinition$ParticipantRole": "Specify the speaker you want to define. Omitting this parameter is equivalent to specifying both participants.
", + "InterruptionFilter$ParticipantRole": "Specify the interrupter you want to flag. Omitting this parameter is equivalent to specifying both participants.
", + "SentimentFilter$ParticipantRole": "Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.
", + "TranscriptFilter$ParticipantRole": "Specify the participant you want to flag. Omitting this parameter is equivalent to specifying both participants.
" } }, "Percentage": { "base": null, "refs": { - "RelativeTimeRange$StartPercentage": "A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
StartPercentage - 10
EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
", - "RelativeTimeRange$EndPercentage": "A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify a start percentage and an end percentage. For example, if you specify the following values:
StartPercentage - 10
EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
", - "RelativeTimeRange$First": "A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For example, if you specify 120000, the time range is set for the first 120,000 milliseconds of the call.
A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to the end of the call. For example, if you specify 120000, the time range is set for the last 120,000 milliseconds of the call.
The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your media file. If you include StartPercentage in your request, you must also include EndPercentage.
The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your media file. If you include EndPercentage in your request, you must also include StartPercentage.
The time, in percentage, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.
", + "RelativeTimeRange$Last": "The time, in percentage, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.
" } }, "Phrase": { @@ -872,8 +895,8 @@ "Phrases": { "base": null, "refs": { - "CreateVocabularyRequest$Phrases": "Use this flag to include a list of terms within your request.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
An array of strings containing the vocabulary entries.
" + "CreateVocabularyRequest$Phrases": "Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
", + "UpdateVocabularyRequest$Phrases": "Use this parameter if you want to update your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.
Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
" } }, "PiiEntityType": { @@ -885,32 +908,32 @@ "PiiEntityTypes": { "base": null, "refs": { - "ContentRedaction$PiiEntityTypes": "The types of personally identifiable information (PII) you want to redact in your transcript.
" + "ContentRedaction$PiiEntityTypes": "Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.
The output transcript file stored in either the default S3 bucket or in a bucket you specify.
When you choose redacted Amazon Transcribe outputs only the redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
Specify if you want only a redacted transcript, or if you want a redacted and an unredacted transcript.
When you choose redacted Amazon Transcribe creates only a redacted transcript.
When you choose redacted_and_unredacted Amazon Transcribe creates a redacted and an unredacted transcript (as two separate files).
Request parameter that defines the entities to be redacted. The only accepted value is PII.
Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
", + "base": "A time range, in percentage, between two points in your media file.
You can use StartPercentage and EndPercentage to search a custom segment. For example, setting StartPercentage to 10 and EndPercentage to 50 only searches for your specified criteria in the audio contained between the 10 percent mark and the 50 percent mark of your media file.
You can use also First to search from the start of the media file until the time you specify, or Last to search from the time you specify until the end of the media file. For example, setting First to 10 only searches for your specified criteria in the audio contained in the first 10 percent of the media file.
If you prefer to use milliseconds instead of percentage, see .
", "refs": { - "InterruptionFilter$RelativeTimeRange": "An object that allows percentages to specify the proportion of the call where there was a interruption. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
", - "NonTalkTimeFilter$RelativeTimeRange": "An object that allows percentages to specify the proportion of the call where there was silence. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
", - "SentimentFilter$RelativeTimeRange": "The time range, set in percentages, that correspond to proportion of the call.
", - "TranscriptFilter$RelativeTimeRange": "An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
" + "InterruptionFilter$RelativeTimeRange": "Allows you to specify a time range (in percentage) in your media file, during which you want to search for an interruption. See for more detail.
", + "NonTalkTimeFilter$RelativeTimeRange": "Allows you to specify a time range (in percentage) in your media file, during which you want to search for a period of silence. See for more detail.
", + "SentimentFilter$RelativeTimeRange": "Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified sentiments. See for more detail.
", + "TranscriptFilter$RelativeTimeRange": "Allows you to specify a time range (in percentage) in your media file, during which you want to search for the specified key words or phrases. See for more detail.
" } }, "Rule": { - "base": "A condition in the call between the customer and the agent that you want to filter for.
", + "base": "A rule is a set of criteria you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.
Rules can include these parameters: , , , and . To learn more about these parameters, refer to Rule criteria.
To learn more about Call Analytics categories, see Creating categories.
To learn more about Call Analytics, see Analyzing call center audio with Call Analytics.
", "refs": { "RuleList$member": null } @@ -918,15 +941,15 @@ "RuleList": { "base": null, "refs": { - "CategoryProperties$Rules": "The rules used to create a call analytics category.
", - "CreateCallAnalyticsCategoryRequest$Rules": "Rules make up a call analytics category. When creating a call analytics category, you must create between 1 and 20 rules for your category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.
", - "UpdateCallAnalyticsCategoryRequest$Rules": "The rules used for the updated analytics category. The rules that you provide in this field replace the ones that are currently being used.
" + "CategoryProperties$Rules": "The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.
", + "CreateCallAnalyticsCategoryRequest$Rules": "Rules define a Call Analytics category. When creating a new Call Analytics category, you must create between 1 and 20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the last 30 seconds of the call.
", + "UpdateCallAnalyticsCategoryRequest$Rules": "The rules used for the updated Call Analytics category. The rules you provide in this field replace the ones that are currently being used in the specified category.
" } }, "SentimentFilter": { - "base": "An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.
", + "base": "Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.
Rules using SentimentFilter are designed to match:
The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call
The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call
The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call
The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call
See Rule criteria for examples.
", "refs": { - "Rule$SentimentFilter": "A condition that is applied to a particular customer sentiment.
" + "Rule$SentimentFilter": "Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.
" } }, "SentimentValue": { @@ -938,22 +961,22 @@ "SentimentValueList": { "base": null, "refs": { - "SentimentFilter$Sentiments": "An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.
" + "SentimentFilter$Sentiments": "Specify the sentiments you want to flag.
" } }, "Settings": { - "base": "Provides optional settings for the StartTranscriptionJob operation.
Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
", "refs": { - "StartTranscriptionJobRequest$Settings": "A Settings object that provides optional settings for a transcription job.
Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
" + "StartTranscriptionJobRequest$Settings": "Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.
Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, do not use the Settings parameter; use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.
", - "MedicalTranscriptionJobSummary$Specialty": "The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.
", - "StartMedicalTranscriptionJobRequest$Specialty": "The medical specialty of any clinician speaking in the input media.
" + "MedicalTranscriptionJob$Specialty": "Describes the medical specialty represented in your media.
", + "MedicalTranscriptionJobSummary$Specialty": "Provides the medical specialty represented in your media.
", + "StartMedicalTranscriptionJobRequest$Specialty": "Specify the predominant medical specialty represented in your media. For batch transcriptions, PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
The phrases that you're specifying for the transcript filter to match.
" + "TranscriptFilter$Targets": "Specify the phrases you want to flag.
" } }, "SubtitleFileUris": { "base": null, "refs": { - "SubtitlesOutput$SubtitleFileUris": "Contains the output location for your subtitle file. This location must be an S3 bucket.
" + "SubtitlesOutput$SubtitleFileUris": "The Amazon S3 location of your transcript. You can use this URI to access or download your subtitle file. Your subtitle file is stored in the same location as your transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are provided.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request, your subtitle file is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.
Specify the output format for your subtitle file; if you select both srt and vtt formats, two output files are generated.
The format of your subtitle files. If your request specified both srt and vtt formats, both formats are shown.
Specify the output format for your subtitle file; if you select both WebVTT (vtt) and SubRip (srt) formats, two output files are generated.
Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.
Defines the starting value that is assigned to the first subtitle segment.
The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.
Shows the output start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.
Specify the starting value that is assigned to the first subtitle segment.
The default start index for Amazon Transcribe is 0, which differs from the more widely used standard of 1. If you're uncertain which value to use, we recommend choosing 1, as this may improve compatibility with other services.
Provides the start index value for your subtitle files. If you did not specify a value in your request, the default value of 0 is used.
Generate subtitles for your batch transcription job. Note that your subtitle files are placed in the same location as your transcription output.
", + "base": "Generate subtitles for your media file with your transcription request.
You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format.
Note that your subtitle files are placed in the same location as your transcription output.
", "refs": { - "StartTranscriptionJobRequest$Subtitles": "Add subtitles to your batch transcription job.
" + "StartTranscriptionJobRequest$Subtitles": "Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip (*.srt) formats.
" } }, "SubtitlesOutput": { - "base": "The S3 location where your subtitle files are located. Note that your subtitle files are placed in the same location as your transcription output. Refer to TranscriptFileUri to download your files.
Provides information about your subtitle file, including format, start index, and Amazon S3 location.
", "refs": { - "TranscriptionJob$Subtitles": "Generate subtitles for your batch transcription job.
" + "TranscriptionJob$Subtitles": "Generate subtitles for your media file with your transcription request.
" } }, "Tag": { - "base": "A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
", + "base": "Adds metadata, in the form of a key:value pair, to the specified resource.
For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.
To learn more about tagging, see Tagging resources.
", "refs": { "TagList$member": null } @@ -1048,29 +1071,29 @@ "TagKey": { "base": null, "refs": { - "Tag$Key": "The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
", + "Tag$Key": "The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.
A list of tag keys you want to remove from a specified Amazon Transcribe resource.
" + "UntagResourceRequest$TagKeys": "Removes the specified tag keys from the specified Amazon Transcribe resource.
" } }, "TagList": { "base": null, "refs": { - "CreateLanguageModelRequest$Tags": "Optionally add tags, each in the form of a key:value pair, to your new language model. See also: .
", - "CreateMedicalVocabularyRequest$Tags": "Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create the new vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", - "CreateVocabularyFilterRequest$Tags": "Adds one or more tags, each in the form of a key:value pair, to a new vocabulary filter at the time you create this new vocabulary filter.
", - "CreateVocabularyRequest$Tags": "Adds one or more tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.
", - "ListTagsForResourceResponse$Tags": "Lists all tags associated with the given transcription job, vocabulary, or resource.
", - "MedicalTranscriptionJob$Tags": "A key:value pair assigned to a given medical transcription job.
", - "StartMedicalTranscriptionJobRequest$Tags": "Add tags to an Amazon Transcribe Medical transcription job.
", - "StartTranscriptionJobRequest$Tags": "Add tags to an Amazon Transcribe transcription job.
", - "TagResourceRequest$Tags": "The tags you are assigning to a given Amazon Transcribe resource.
", - "TranscriptionJob$Tags": "A key:value pair assigned to a given transcription job.
" + "CreateLanguageModelRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "CreateMedicalVocabularyRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "CreateVocabularyFilterRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "CreateVocabularyRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "ListTagsForResourceResponse$Tags": "Lists all tags associated with the given transcription job, vocabulary, model, or resource.
", + "MedicalTranscriptionJob$Tags": "The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
", + "StartMedicalTranscriptionJobRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "StartTranscriptionJobRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "TagResourceRequest$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
", + "TranscriptionJob$Tags": "Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
" } }, "TagResourceRequest": { @@ -1086,93 +1109,93 @@ "TagValue": { "base": null, "refs": { - "Tag$Value": "The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
" + "Tag$Value": "The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.
Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
" } }, "TimestampMilliseconds": { "base": null, "refs": { - "AbsoluteTimeRange$StartTime": "A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
StartTime - 10000
Endtime - 50000
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
", - "AbsoluteTimeRange$EndTime": "A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start time and an end time. For example, if you specify the following values:
StartTime - 10000
Endtime - 50000
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
", - "AbsoluteTimeRange$First": "A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000, the time range is set to the first 100,000 milliseconds of the call.
A time range from the value that you've specified to the end of the call. For example, if you specify 100000, the time range is set to the last 100,000 milliseconds of the call.
The duration of the interruption.
", - "NonTalkTimeFilter$Threshold": "The duration of the period when neither the customer nor agent was talking.
" + "AbsoluteTimeRange$StartTime": "The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your audio. If you include StartTime in your request, you must also include EndTime.
The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your audio. If you include EndTime in your request, you must also include StartTime.
The time, in milliseconds, from the start of your media file until the value you specify in which Amazon Transcribe searches for your specified criteria.
", + "AbsoluteTimeRange$Last": "The time, in milliseconds, from the value you specify until the end of your media file in which Amazon Transcribe searches for your specified criteria.
", + "InterruptionFilter$Threshold": "Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains more than 10000 milliseconds of interruptions.
", + "NonTalkTimeFilter$Threshold": "Specify the duration, in milliseconds, of the period of silence you want to flag. For example, you can flag a silent period that lasts 30000 milliseconds.
" } }, "TranscribeArn": { "base": null, "refs": { - "ListTagsForResourceRequest$ResourceArn": "Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
Lists all tags associated with the given Amazon Resource Name (ARN).
", - "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
The Amazon Resource Name (ARN) specified in your request.
", + "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id.
For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job, medical-transcription-job, vocabulary, medical-vocabulary, vocabulary-filter, and language-model.
Identifies the location of a transcription.
", + "base": "Provides you with the Amazon S3 URI you can use to access your transcript.
", "refs": { "CallAnalyticsJob$Transcript": null, - "TranscriptionJob$Transcript": "An object that describes the output of the transcription job.
" + "TranscriptionJob$Transcript": "Provides you with the Amazon S3 URI you can use to access your transcript.
" } }, "TranscriptFilter": { - "base": "Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.
", + "base": "Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.
Rules using TranscriptFilter are designed to match:
Custom words or phrases spoken by the agent, the customer, or both
Custom words or phrases not spoken by the agent, the customer, or either
Custom words or phrases that occur at a specific time frame
See Rule criteria for examples.
", "refs": { - "Rule$TranscriptFilter": "A condition that catches particular words or phrases based on a exact match. For example, if you set the phrase \"I want to speak to the manager\", only that exact phrase will be returned.
" + "Rule$TranscriptFilter": "Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.
" } }, "TranscriptFilterType": { "base": null, "refs": { - "TranscriptFilter$TranscriptFilterType": "Matches the phrase to the transcription output in a word for word fashion. For example, if you specify the phrase \"I want to speak to the manager.\" Amazon Transcribe attempts to match that specific phrase to the transcription.
" + "TranscriptFilter$TranscriptFilterType": "Flag the presence or absence of an exact match to the phrases you specify. For example, if you specify the phrase \"speak to a manager\" as your Targets value, only that exact phrase is flagged.
Note that semantic matching is not supported. For example, if your customer says \"speak to the manager\", instead of \"speak to a manager\", your content is not flagged.
" } }, "TranscriptionJob": { - "base": "Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.
Provides detailed information about a transcription job.
To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.
An object that contains the results of the transcription job.
", - "StartTranscriptionJobResponse$TranscriptionJob": "Provides information about your asynchronous transcription job.
" + "GetTranscriptionJobResponse$TranscriptionJob": "Provides detailed information about the specified transcription job, including job status and, if applicable, failure reason.
", + "StartTranscriptionJobResponse$TranscriptionJob": "Provides detailed information about the current transcription job, including job status and, if applicable, failure reason.
" } }, "TranscriptionJobName": { "base": null, "refs": { - "DeleteMedicalTranscriptionJobRequest$MedicalTranscriptionJobName": "The name of the medical transcription job you want to delete. Job names are case-sensitive.
", - "DeleteTranscriptionJobRequest$TranscriptionJobName": "The name of the transcription job you want to delete. Job names are case-sensitive.
", - "GetMedicalTranscriptionJobRequest$MedicalTranscriptionJobName": "The name of the medical transcription job you want information about. This value is case sensitive.
", - "GetTranscriptionJobRequest$TranscriptionJobName": "The name of the job.
", - "ListMedicalTranscriptionJobsRequest$JobNameContains": "When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
", - "ListTranscriptionJobsRequest$JobNameContains": "When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
", - "MedicalTranscriptionJob$MedicalTranscriptionJobName": "The name for a given medical transcription job.
", - "MedicalTranscriptionJobSummary$MedicalTranscriptionJobName": "The name of a medical transcription job.
", - "StartMedicalTranscriptionJobRequest$MedicalTranscriptionJobName": "The name of the medical transcription job. You can't use the strings \".\" or \"..\" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
The name of the job. You can't use the strings \".\" or \"..\" by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.
The name of the transcription job.
", - "TranscriptionJobSummary$TranscriptionJobName": "The name of the transcription job.
" + "DeleteMedicalTranscriptionJobRequest$MedicalTranscriptionJobName": "The name of the medical transcription job you want to delete. Job names are case sensitive.
", + "DeleteTranscriptionJobRequest$TranscriptionJobName": "The name of the transcription job you want to delete. Job names are case sensitive.
", + "GetMedicalTranscriptionJobRequest$MedicalTranscriptionJobName": "The name of the medical transcription job you want information about. Job names are case sensitive.
", + "GetTranscriptionJobRequest$TranscriptionJobName": "The name of the transcription job you want information about. Job names are case sensitive.
", + "ListMedicalTranscriptionJobsRequest$JobNameContains": "Returns only the medical transcription jobs that contain the specified string. The search is not case sensitive.
", + "ListTranscriptionJobsRequest$JobNameContains": "Returns only the transcription jobs that contain the specified string. The search is not case sensitive.
", + "MedicalTranscriptionJob$MedicalTranscriptionJobName": "The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
", + "MedicalTranscriptionJobSummary$MedicalTranscriptionJobName": "The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
", + "StartMedicalTranscriptionJobRequest$MedicalTranscriptionJobName": "A unique name, chosen by you, for your medical transcription job. The name you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
A unique name, chosen by you, for your transcription job. The name you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
", + "TranscriptionJobSummary$TranscriptionJobName": "The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
" } }, "TranscriptionJobStatus": { "base": null, "refs": { - "ListMedicalTranscriptionJobsRequest$Status": "When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
", - "ListMedicalTranscriptionJobsResponse$Status": "The requested status of the medical transcription jobs returned.
", - "ListTranscriptionJobsRequest$Status": "When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
", - "ListTranscriptionJobsResponse$Status": "The requested status of the jobs returned.
", - "MedicalTranscriptionJob$TranscriptionJobStatus": "The completion status of a medical transcription job.
", - "MedicalTranscriptionJobSummary$TranscriptionJobStatus": "The status of the medical transcription job.
", - "TranscriptionJob$TranscriptionJobStatus": "The status of the transcription job.
", - "TranscriptionJobSummary$TranscriptionJobStatus": "The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.
Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.
Lists all medical transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
", + "ListTranscriptionJobsRequest$Status": "Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all transcription jobs are returned.
Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
", + "MedicalTranscriptionJob$TranscriptionJobStatus": "Provides the status of the specified medical transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
Provides the status of your medical transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.
Provides the status of the specified transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
Provides the status of your transcription job.
If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
A list of objects containing summary information for a transcription job.
" + "ListTranscriptionJobsResponse$TranscriptionJobSummaries": "Provides a summary of information about each result.
" } }, "TranscriptionJobSummary": { - "base": "Provides a summary of information about a transcription job.
", + "base": "Provides detailed information about a specific transcription job.
", "refs": { "TranscriptionJobSummaries$member": null } @@ -1180,9 +1203,9 @@ "Type": { "base": null, "refs": { - "MedicalTranscriptionJob$Type": "The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see What is Amazon Transcribe Medical?.
The speech of the clinician in the input audio.
", - "StartMedicalTranscriptionJobRequest$Type": "The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
Specify whether your input media contains only one person (DICTATION) or contains a conversation between two people (CONVERSATION).
For example, DICTATION could be used for a medical professional wanting to transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office visit.
The Amazon S3 location (URI) of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you're calling.
Here's an example URI path:
https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
Your vocabulary filter file must be less than 50 KB in size.
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.
The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.
Here's an example URI path:
https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.
", - "GetVocabularyFilterResponse$DownloadUri": "The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
", - "GetVocabularyResponse$DownloadUri": "The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
", - "InputDataConfig$S3Uri": "The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.
", - "InputDataConfig$TuningDataS3Uri": "The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.
", - "Media$MediaFileUri": "The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:
s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey
For example:
s3://DOC-EXAMPLE-BUCKET/example.flac
s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
", - "Media$RedactedMediaFileUri": "The S3 object location for your redacted output media file. This is only supported for call analytics jobs.
", - "MedicalTranscript$TranscriptFileUri": "The S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
", - "StartCallAnalyticsJobRequest$OutputLocation": "The Amazon S3 location where the output of the call analytics job is stored. You can provide the following location types to store the output of call analytics job:
s3://DOC-EXAMPLE-BUCKET1
If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
s3://DOC-EXAMPLE-BUCKET1/folder/
f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.
If you specify a folder, you must provide a trailing slash.
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.
If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your S3 bucket.
The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.
The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
The S3 location where the specified medical vocabulary is stored; use this URI to view or download the vocabulary.
", + "GetVocabularyFilterResponse$DownloadUri": "The Amazon S3 location where the vocabulary filter is stored; use this URI to view or download the vocabulary filter.
", + "GetVocabularyResponse$DownloadUri": "The S3 location where the vocabulary is stored; use this URI to view or download the vocabulary.
", + "InputDataConfig$S3Uri": "The Amazon S3 location (URI) of the text files you want to use to train your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
The Amazon S3 location of the media file you want to transcribe. For example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
", + "Media$RedactedMediaFileUri": "The Amazon S3 location of the media file you want to redact. For example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
RedactedMediaFileUri is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.
The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.
The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location:
s3://DOC-EXAMPLE-BUCKET
s3://DOC-EXAMPLE-BUCKET/my-output-folder/
s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.
If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
The S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey
For example:
https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
", - "UpdateVocabularyFilterRequest$VocabularyFilterFileUri": "The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:
https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey
For example:
https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
" + "Transcript$TranscriptFileUri": "The Amazon S3 location of your transcript. You can use this URI to access or download your transcript.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and TranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.
The Amazon S3 location of your redacted transcript. You can use this URI to access or download your transcript.
If you included OutputBucketName in your transcription job request, this is the URI of that bucket. If you also included OutputKey in your request, your output is located in the path you specified in your request.
If you didn't include OutputBucketName in your transcription job request, your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri provides you with a temporary URI you can use for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 minutes. If you get an AccesDenied error, you can get a new temporary URI by running a GetTranscriptionJob or ListTranscriptionJob request.
The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.
The Amazon S3 location of the text file that contains your custom vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.
A list of objects that describe the vocabularies that match your search criteria.
", - "ListVocabulariesResponse$Vocabularies": "A list of objects that describe the vocabularies that match the search criteria in the request.
" + "ListMedicalVocabulariesResponse$Vocabularies": "Provides information about the custom medical vocabularies that match the criteria specified in your request.
", + "ListVocabulariesResponse$Vocabularies": "Provides information about the custom vocabularies that match the criteria specified in your request.
" } }, "VocabularyFilterInfo": { - "base": "Provides information about a vocabulary filter.
", + "base": "Provides information about a vocabulary filter, including the language of the filter, when it was last modified, and its name.
", "refs": { "VocabularyFilters$member": null } @@ -1274,35 +1297,35 @@ "VocabularyFilterMethod": { "base": null, "refs": { - "CallAnalyticsJobSettings$VocabularyFilterMethod": "Set to mask to remove filtered text from the transcript and replace it with three asterisks (\"***\") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
Set to mask to remove filtered text from the transcript and replace it with three asterisks (\"***\") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text. Set to tag to mark the word in the transcription output that matches the vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter are not masked or removed.
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
Specify how you want your vocabulary filter applied to your transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the same language code as the analytics job.
", - "CreateVocabularyFilterRequest$VocabularyFilterName": "The name of your new vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary filter with the same name as a previous vocabulary filter, you get a ConflictException error.
The name of the vocabulary filter.
", - "DeleteVocabularyFilterRequest$VocabularyFilterName": "The name of the vocabulary filter you want to delete. Vocabulary filter names are case-sensitive.
", - "GetVocabularyFilterRequest$VocabularyFilterName": "The name of the vocabulary filter for which to return information.
", - "GetVocabularyFilterResponse$VocabularyFilterName": "The name of the vocabulary filter.
", - "LanguageIdSettings$VocabularyFilterName": "The name of the vocabulary filter you want to use when transcribing your audio. The filter you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary filter isn't be applied.
", - "ListVocabularyFiltersRequest$NameContains": "Filters the response so that it only contains vocabulary filters whose name contains the specified string.
", - "Settings$VocabularyFilterName": "The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
", - "UpdateVocabularyFilterRequest$VocabularyFilterName": "The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.
The name of the updated vocabulary filter.
", - "VocabularyFilterInfo$VocabularyFilterName": "The name of the vocabulary filter. The name must be unique in the account that holds the filter.
" + "CallAnalyticsJobSettings$VocabularyFilterName": "The name of the custom vocabulary filter you want to include in your Call Analytics transcription request. Vocabulary filter names are case sensitive.
Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new vocabulary filter with the same name as an existing vocabulary filter, you get a ConflictException error.
The name you chose for your custom vocabulary filter.
", + "DeleteVocabularyFilterRequest$VocabularyFilterName": "The name of the custom vocabulary filter you want to delete. Vocabulary filter names are case sensitive.
", + "GetVocabularyFilterRequest$VocabularyFilterName": "The name of the custom vocabulary filter you want information about. Vocabulary filter names are case sensitive.
", + "GetVocabularyFilterResponse$VocabularyFilterName": "The name of the custom vocabulary filter you requested information about.
", + "LanguageIdSettings$VocabularyFilterName": "The name of the custom vocabulary filter you want to use when processing your transcription job. Vocabulary filter names are case sensitive.
The language of the specified vocabulary filter must match the language code you specify in your transcription request. If the languages don't match, the vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.
", + "Settings$VocabularyFilterName": "The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
The name of the custom vocabulary filter you want to update. Vocabulary filter names are case sensitive.
", + "UpdateVocabularyFilterResponse$VocabularyFilterName": "The name of the updated custom vocabulary filter.
", + "VocabularyFilterInfo$VocabularyFilterName": "A unique name, chosen by you, for your custom vocabulary filter. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
" } }, "VocabularyFilters": { "base": null, "refs": { - "ListVocabularyFiltersResponse$VocabularyFilters": "The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
Provides information about the custom vocabulary filters that match the criteria specified in your request.
" } }, "VocabularyInfo": { - "base": "Provides information about a custom vocabulary.
", + "base": "Provides information about a custom vocabulary, including the language of the vocabulary, when it was last modified, its name, and the processing state.
", "refs": { "Vocabularies$member": null } @@ -1310,43 +1333,43 @@ "VocabularyName": { "base": null, "refs": { - "CallAnalyticsJobSettings$VocabularyName": "The name of a vocabulary to use when processing the call analytics job.
", - "CreateMedicalVocabularyRequest$VocabularyName": "The name of your new vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a ConflictException error.
The name you chose for your vocabulary.
", - "CreateVocabularyRequest$VocabularyName": "The name of your new vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a ConflictException error.
The name you chose for your vocabulary.
", - "DeleteMedicalVocabularyRequest$VocabularyName": "The name of the vocabulary that you want to delete. Vocabulary names are case-sensitive.
", - "DeleteVocabularyRequest$VocabularyName": "The name of the vocabulary you want to delete. Vocabulary names are case-sensitive.
", - "GetMedicalVocabularyRequest$VocabularyName": "The name of the medical vocabulary you want information about. This value is case sensitive.
", - "GetMedicalVocabularyResponse$VocabularyName": "The name of the vocabulary returned by Amazon Transcribe Medical.
", - "GetVocabularyRequest$VocabularyName": "The name of the vocabulary to return information about. The name is case sensitive.
", - "GetVocabularyResponse$VocabularyName": "The name of the vocabulary to return.
", - "LanguageIdSettings$VocabularyName": "The name of the vocabulary you want to use when processing your transcription job. The vocabulary you specify must have the same language codes as the transcription job; if the languages don't match, the vocabulary isn't applied.
", - "ListMedicalVocabulariesRequest$NameContains": "Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both \"vocabularyname\" and \"VocabularyName\".
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns both \"vocabularyname\" and \"VocabularyName\" in the response list.
The name of the vocabulary to use when processing a medical transcription job.
", - "Settings$VocabularyName": "The name of a vocabulary to use when processing the transcription job.
", - "UpdateMedicalVocabularyRequest$VocabularyName": "The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a ConflictException error.
The name of the updated vocabulary.
", - "UpdateVocabularyRequest$VocabularyName": "The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
The name of the vocabulary that was updated.
", - "VocabularyInfo$VocabularyName": "The name of the vocabulary.
" + "CallAnalyticsJobSettings$VocabularyName": "The name of the custom vocabulary you want to include in your Call Analytics transcription request. Vocabulary names are case sensitive.
", + "CreateMedicalVocabularyRequest$VocabularyName": "A unique name, chosen by you, for your new custom medical vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new medical vocabulary with the same name as an existing medical vocabulary, you get a ConflictException error.
The name you chose for your custom medical vocabulary.
", + "CreateVocabularyRequest$VocabularyName": "A unique name, chosen by you, for your new custom vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new vocabulary with the same name as an existing vocabulary, you get a ConflictException error.
The name you chose for your custom vocabulary.
", + "DeleteMedicalVocabularyRequest$VocabularyName": "The name of the custom medical vocabulary you want to delete. Vocabulary names are case sensitive.
", + "DeleteVocabularyRequest$VocabularyName": "The name of the custom vocabulary you want to delete. Vocabulary names are case sensitive.
", + "GetMedicalVocabularyRequest$VocabularyName": "The name of the custom medical vocabulary you want information about. Vocabulary names are case sensitive.
", + "GetMedicalVocabularyResponse$VocabularyName": "The name of the custom medical vocabulary you requested information about.
", + "GetVocabularyRequest$VocabularyName": "The name of the custom vocabulary you want information about. Vocabulary names are case sensitive.
", + "GetVocabularyResponse$VocabularyName": "The name of the custom vocabulary you requested information about.
", + "LanguageIdSettings$VocabularyName": "The name of the custom vocabulary you want to use when processing your transcription job. Vocabulary names are case sensitive.
The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
", + "ListMedicalVocabulariesRequest$NameContains": "Returns only the custom medical vocabularies that contain the specified string. The search is not case sensitive.
", + "ListVocabulariesRequest$NameContains": "Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.
", + "MedicalTranscriptionSetting$VocabularyName": "The name of the custom vocabulary you want to use when processing your medical transcription job. Vocabulary names are case sensitive.
The language of the specified vocabulary must match the language code you specify in your transcription request. If the languages don't match, the vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
", + "UpdateMedicalVocabularyRequest$VocabularyName": "The name of the custom medical vocabulary you want to update. Vocabulary names are case sensitive.
", + "UpdateMedicalVocabularyResponse$VocabularyName": "The name of the updated custom medical vocabulary.
", + "UpdateVocabularyRequest$VocabularyName": "The name of the custom vocabulary you want to update. Vocabulary names are case sensitive.
", + "UpdateVocabularyResponse$VocabularyName": "The name of the updated custom vocabulary.
", + "VocabularyInfo$VocabularyName": "A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
" } }, "VocabularyState": { "base": null, "refs": { "CreateMedicalVocabularyResponse$VocabularyState": "The processing state of your custom medical vocabulary. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.
The processing state of your vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.
The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
The processing state of the vocabulary.
", - "ListMedicalVocabulariesRequest$StateEquals": "When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.
The requested vocabulary state.
", - "ListVocabulariesRequest$StateEquals": "When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
The requested vocabulary state.
", - "UpdateMedicalVocabularyResponse$VocabularyState": "The processing state of the update to the vocabulary. When the VocabularyState field is READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.
The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.
The processing state of your custom medical vocabulary. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.
Returns only custom medical vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.
Lists all custom medical vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
", + "ListVocabulariesRequest$StateEquals": "Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.
Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
", + "UpdateMedicalVocabularyResponse$VocabularyState": "The processing state of your custom medical vocabulary. If the state is READY, you can use the vocabulary in a StartMedicalTranscriptionJob request.
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.
The processing state of your custom vocabulary. If the state is READY, you can use the vocabulary in a StartTranscriptionJob request.
The words you want in your vocabulary filter. Only use characters specified in the Character sets for the language you're transcribing.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
", + "UpdateVocabularyFilterRequest$Words": "Use this parameter if you want to update your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
" } } } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index e4cc3a49dc1..60eef325dac 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -1114,7 +1114,9 @@ }, "app-integrations" : { "endpoints" : { + "af-south-1" : { }, "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, diff --git a/service/cognitoidentityprovider/api.go b/service/cognitoidentityprovider/api.go index 46ab5024c97..af2a6501f85 100644 --- a/service/cognitoidentityprovider/api.go +++ b/service/cognitoidentityprovider/api.go @@ -808,8 +808,8 @@ func (c *CognitoIdentityProvider) AdminDisableProviderForUserRequest(input *Admi // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * InternalErrorException @@ -1585,8 +1585,8 @@ func (c *CognitoIdentityProvider) AdminLinkProviderForUserRequest(input *AdminLi // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * LimitExceededException @@ -2426,8 +2426,8 @@ func (c *CognitoIdentityProvider) AdminRespondToAuthChallengeRequest(input *Admi // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * PasswordResetRequiredException @@ -3090,8 +3090,8 @@ func (c *CognitoIdentityProvider) AdminUpdateUserAttributesRequest(input *AdminU // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * TooManyRequestsException @@ -3292,15 +3292,23 @@ func (c *CognitoIdentityProvider) AssociateSoftwareTokenRequest(input *Associate // AssociateSoftwareToken API operation for Amazon Cognito Identity Provider. // -// Returns a unique generated shared secret key code for the user account. The -// request takes an access token or a session string, but not both. +// Begins setup of time-based one-time password multi-factor authentication +// (TOTP MFA) for a user, with a unique private key that Amazon Cognito generates +// and returns in the API response. You can authorize an AssociateSoftwareToken +// request with either the user's access token, or a session string from a challenge +// response that you received from Amazon Cognito. // -// Calling AssociateSoftwareToken immediately disassociates the existing software -// token from the user account. If the user doesn't subsequently verify the -// software token, their account is set up to authenticate without MFA. If MFA -// config is set to Optional at the user pool level, the user can then log in -// without MFA. However, if MFA is set to Required for the user pool, the user -// is asked to set up a new software token MFA during sign-in. +// Amazon Cognito disassociates an existing software token when you verify the +// new token in a VerifySoftwareToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html) +// API request. If you don't verify the software token and your user pool doesn't +// require MFA, the user can then authenticate with user name and password credentials +// alone. If your user pool requires TOTP MFA, Amazon Cognito generates an MFA_SETUP +// or SOFTWARE_TOKEN_SETUP challenge each time your user signs. Complete setup +// with AssociateSoftwareToken and VerifySoftwareToken. +// +// After you set up software token MFA for your user, Amazon Cognito generates +// a SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to this challenge +// with your user's TOTP. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3808,8 +3816,8 @@ func (c *CognitoIdentityProvider) ConfirmSignUpRequest(input *ConfirmSignUpInput // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * TooManyRequestsException @@ -9135,8 +9143,8 @@ func (c *CognitoIdentityProvider) RespondToAuthChallengeRequest(input *RespondTo // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * InternalErrorException @@ -10978,8 +10986,8 @@ func (c *CognitoIdentityProvider) UpdateUserAttributesRequest(input *UpdateUserA // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // * InvalidSmsRoleAccessPolicyException @@ -11631,8 +11639,8 @@ func (c *CognitoIdentityProvider) VerifyUserAttributeRequest(input *VerifyUserAt // * AliasExistsException // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttribute @@ -13669,9 +13677,10 @@ type AdminInitiateAuthInput struct { // sensitive information. ClientMetadata map[string]*string `type:"map"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. ContextData *ContextDataType `type:"structure"` // The ID of the Amazon Cognito user pool. @@ -14778,9 +14787,10 @@ type AdminRespondToAuthChallengeInput struct { // sensitive information. ClientMetadata map[string]*string `type:"map"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. ContextData *ContextDataType `type:"structure"` // The session that should be passed both ways in challenge-response calls to @@ -15817,8 +15827,8 @@ func (s AdminUserGlobalSignOutOutput) GoString() string { // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias -// from a different account. This exception indicates that an account with this -// email address or phone already exists in a user pool that you've configured +// for a different user profile. This exception indicates that an account with +// this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. type AliasExistsException struct { _ struct{} `type:"structure"` @@ -17076,9 +17086,10 @@ type ConfirmForgotPasswordInput struct { // String and GoString methods. SecretHash *string `min:"1" type:"string" sensitive:"true"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` // The user name of the user for whom you want to enter a code to retrieve a @@ -17284,9 +17295,10 @@ type ConfirmSignUpInput struct { // String and GoString methods. SecretHash *string `min:"1" type:"string" sensitive:"true"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` // The user name of the user whose registration you want to confirm. @@ -17424,8 +17436,9 @@ func (s ConfirmSignUpOutput) GoString() string { type ContextDataType struct { _ struct{} `type:"structure"` - // Encoded data containing device fingerprinting details collected using the - // Amazon Cognito context data collection library. + // Encoded device-fingerprint details that your app collected with the Amazon + // Cognito context data collection library. For more information, see Adding + // user device and session data to API requests (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). EncodedData *string `type:"string"` // HttpHeaders received on your server in same order. @@ -17433,7 +17446,7 @@ type ContextDataType struct { // HttpHeaders is a required field HttpHeaders []*HttpHeader `type:"list" required:"true"` - // Source IP address of your user. + // The source IP address of your user's device. // // IpAddress is a required field IpAddress *string `type:"string" required:"true"` @@ -18168,6 +18181,15 @@ type CreateUserPoolClientInput struct { // App callback URLs such as myapp://example are also supported. DefaultRedirectURI *string `min:"1" type:"string"` + // Activates the propagation of additional user context data. For more information + // about propagation of user context data, see Adding advanced security to a + // user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). + // If you don’t include this parameter, you can't send device fingerprint + // information, including source IP address, to Amazon Cognito advanced security. + // You can only activate EnablePropagateAdditionalUserContextData in an app + // client that has a client secret. + EnablePropagateAdditionalUserContextData *bool `type:"boolean"` + // Activates or deactivates token revocation. For more information about revoking // tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). // @@ -18385,6 +18407,12 @@ func (s *CreateUserPoolClientInput) SetDefaultRedirectURI(v string) *CreateUserP return s } +// SetEnablePropagateAdditionalUserContextData sets the EnablePropagateAdditionalUserContextData field's value. +func (s *CreateUserPoolClientInput) SetEnablePropagateAdditionalUserContextData(v bool) *CreateUserPoolClientInput { + s.EnablePropagateAdditionalUserContextData = &v + return s +} + // SetEnableTokenRevocation sets the EnableTokenRevocation field's value. func (s *CreateUserPoolClientInput) SetEnableTokenRevocation(v bool) *CreateUserPoolClientInput { s.EnableTokenRevocation = &v @@ -18693,7 +18721,11 @@ type CreateUserPoolInput struct { // A string representing the SMS verification message. SmsVerificationMessage *string `min:"6" type:"string"` - // The settings for updates to user attributes. + // The settings for updates to user attributes. These settings include the property + // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells + // Amazon Cognito how to handle changes to the value of your users' email address + // and phone number attributes. For more information, see Verifying updates + // to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `type:"structure"` // Enables advanced security risk detection. Set the key AdvancedSecurityMode @@ -21089,7 +21121,7 @@ type EventContextDataType struct { // The user's device name. DeviceName *string `type:"string"` - // The user's IP address. + // The source IP address of your user's device. IpAddress *string `type:"string"` // The user's time zone. @@ -21456,9 +21488,10 @@ type ForgotPasswordInput struct { // String and GoString methods. SecretHash *string `min:"1" type:"string" sensitive:"true"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` // The user name of the user for whom you want to enter a code to reset a forgotten @@ -21551,8 +21584,7 @@ func (s *ForgotPasswordInput) SetUsername(v string) *ForgotPasswordInput { return s } -// Represents the response from the server regarding the request to reset a -// password. +// The response from Amazon Cognito to a request to reset a password. type ForgotPasswordOutput struct { _ struct{} `type:"structure"` @@ -23048,9 +23080,10 @@ type InitiateAuthInput struct { // sensitive information. ClientMetadata map[string]*string `type:"map"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` } @@ -26304,9 +26337,10 @@ type ResendConfirmationCodeInput struct { // String and GoString methods. SecretHash *string `min:"1" type:"string" sensitive:"true"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` // The username attribute of the user to whom you want to resend a confirmation @@ -26724,9 +26758,10 @@ type RespondToAuthChallengeInput struct { // RespondToAuthChallenge API call. Session *string `min:"20" type:"string"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` } @@ -28008,9 +28043,10 @@ type SignUpInput struct { // name. UserAttributes []*AttributeType `type:"list"` - // Contextual data such as the user's device fingerprint, IP address, or location - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Contextual data about your user session, such as the device fingerprint, + // IP address, or location. Amazon Cognito advanced security evaluates the risk + // of an authentication event based on the context that your app generates and + // passes to Amazon Cognito when it makes API requests. UserContextData *UserContextDataType `type:"structure"` // The user name of the user you want to register. @@ -28841,16 +28877,19 @@ func (s TagResourceOutput) GoString() string { type TokenValidityUnitsType struct { _ struct{} `type:"structure"` - // A time unit in “seconds”, “minutes”, “hours”, or “days” for - // the value in AccessTokenValidity, defaulting to hours. + // A time unit of seconds, minutes, hours, or days for the value that you set + // in the AccessTokenValidity parameter. The default AccessTokenValidity time + // unit is hours. AccessToken *string `type:"string" enum:"TimeUnitsType"` - // A time unit in “seconds”, “minutes”, “hours”, or “days” for - // the value in IdTokenValidity, defaulting to hours. + // A time unit of seconds, minutes, hours, or days for the value that you set + // in the IdTokenValidity parameter. The default IdTokenValidity time unit is + // hours. IdToken *string `type:"string" enum:"TimeUnitsType"` - // A time unit in “seconds”, “minutes”, “hours”, or “days” for - // the value in RefreshTokenValidity, defaulting to days. + // A time unit of seconds, minutes, hours, or days for the value that you set + // in the RefreshTokenValidity parameter. The default RefreshTokenValidity time + // unit is days. RefreshToken *string `type:"string" enum:"TimeUnitsType"` } @@ -30477,6 +30516,15 @@ type UpdateUserPoolClientInput struct { // App callback URLs such as myapp://example are also supported. DefaultRedirectURI *string `min:"1" type:"string"` + // Activates the propagation of additional user context data. For more information + // about propagation of user context data, see Adding advanced security to a + // user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html). + // If you don’t include this parameter, you can't send device fingerprint + // information, including source IP address, to Amazon Cognito advanced security. + // You can only activate EnablePropagateAdditionalUserContextData in an app + // client that has a client secret. + EnablePropagateAdditionalUserContextData *bool `type:"boolean"` + // Activates or deactivates token revocation. For more information about revoking // tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). EnableTokenRevocation *bool `type:"boolean"` @@ -30685,6 +30733,12 @@ func (s *UpdateUserPoolClientInput) SetDefaultRedirectURI(v string) *UpdateUserP return s } +// SetEnablePropagateAdditionalUserContextData sets the EnablePropagateAdditionalUserContextData field's value. +func (s *UpdateUserPoolClientInput) SetEnablePropagateAdditionalUserContextData(v bool) *UpdateUserPoolClientInput { + s.EnablePropagateAdditionalUserContextData = &v + return s +} + // SetEnableTokenRevocation sets the EnableTokenRevocation field's value. func (s *UpdateUserPoolClientInput) SetEnableTokenRevocation(v bool) *UpdateUserPoolClientInput { s.EnableTokenRevocation = &v @@ -30980,7 +31034,11 @@ type UpdateUserPoolInput struct { // A container with information about the SMS verification message. SmsVerificationMessage *string `min:"6" type:"string"` - // The settings for updates to user attributes. + // The settings for updates to user attributes. These settings include the property + // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells + // Amazon Cognito how to handle changes to the value of your users' email address + // and phone number attributes. For more information, see Verifying updates + // to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `type:"structure"` // Enables advanced security risk detection. Set the key AdvancedSecurityMode @@ -31219,7 +31277,11 @@ func (s UpdateUserPoolOutput) GoString() string { return s.String() } -// The settings for updates to user attributes. +// The settings for updates to user attributes. These settings include the property +// AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells +// Amazon Cognito how to handle changes to the value of your users' email address +// and phone number attributes. For more information, see Verifying updates +// to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). type UserAttributeUpdateSettingsType struct { _ struct{} `type:"structure"` @@ -31268,16 +31330,19 @@ func (s *UserAttributeUpdateSettingsType) SetAttributesRequireVerificationBefore return s } -// Information that your app generates about a user's AdminInitiateAuth or AdminRespondToAuthChallenge -// session. Amazon Cognito advanced security features calculate risk levels -// for user sessions based on this context data. +// Contextual data, such as the user's device fingerprint, IP address, or location, +// used for evaluating the risk of an unexpected event by Amazon Cognito advanced +// security. type UserContextDataType struct { _ struct{} `type:"structure"` - // Contextual data, such as the user's device fingerprint, IP address, or location, - // used for evaluating the risk of an unexpected event by Amazon Cognito advanced - // security. + // Encoded device-fingerprint details that your app collected with the Amazon + // Cognito context data collection library. For more information, see Adding + // user device and session data to API requests (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). EncodedData *string `type:"string"` + + // The source IP address of your user's device. + IpAddress *string `type:"string"` } // String returns the string representation. @@ -31304,6 +31369,12 @@ func (s *UserContextDataType) SetEncodedData(v string) *UserContextDataType { return s } +// SetIpAddress sets the IpAddress field's value. +func (s *UserContextDataType) SetIpAddress(v string) *UserContextDataType { + s.IpAddress = &v + return s +} + // This exception is thrown when you're trying to modify a user pool while a // user import job is in progress for that pool. type UserImportInProgressException struct { @@ -32002,6 +32073,24 @@ type UserPoolClientType struct { // App callback URLs such as myapp://example are also supported. DefaultRedirectURI *string `min:"1" type:"string"` + // When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts + // an IpAddress value that you send in the UserContextData parameter. The UserContextData + // parameter sends information to Amazon Cognito advanced security for risk + // analysis. You can send UserContextData when you sign in Amazon Cognito native + // users with the InitiateAuth and RespondToAuthChallenge API operations. + // + // When EnablePropagateAdditionalUserContextData is false, you can't send your + // user's source IP address to Amazon Cognito advanced security with unauthenticated + // API operations. EnablePropagateAdditionalUserContextData doesn't affect whether + // you can send a source IP address in a ContextData parameter with the authenticated + // API operations AdminInitiateAuth and AdminRespondToAuthChallenge. + // + // You can only activate EnablePropagateAdditionalUserContextData in an app + // client that has a client secret. For more information about propagation of + // user context data, see Adding user device and session data to API requests + // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint). + EnablePropagateAdditionalUserContextData *bool `type:"boolean"` + // Indicates whether token revocation is activated for the user pool client. // When you create a new user pool client, token revocation is activated by // default. For more information about revoking tokens, see RevokeToken (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html). @@ -32184,6 +32273,12 @@ func (s *UserPoolClientType) SetDefaultRedirectURI(v string) *UserPoolClientType return s } +// SetEnablePropagateAdditionalUserContextData sets the EnablePropagateAdditionalUserContextData field's value. +func (s *UserPoolClientType) SetEnablePropagateAdditionalUserContextData(v bool) *UserPoolClientType { + s.EnablePropagateAdditionalUserContextData = &v + return s +} + // SetEnableTokenRevocation sets the EnableTokenRevocation field's value. func (s *UserPoolClientType) SetEnableTokenRevocation(v bool) *UserPoolClientType { s.EnableTokenRevocation = &v @@ -32570,7 +32665,11 @@ type UserPoolType struct { // The status of a user pool. Status *string `type:"string" enum:"StatusType"` - // The settings for updates to user attributes. + // The settings for updates to user attributes. These settings include the property + // AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells + // Amazon Cognito how to handle changes to the value of your users' email address + // and phone number attributes. For more information, see Verifying updates + // to to email addresses and phone numbers (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates). UserAttributeUpdateSettings *UserAttributeUpdateSettingsType `type:"structure"` // The user pool add-ons. diff --git a/service/cognitoidentityprovider/errors.go b/service/cognitoidentityprovider/errors.go index 71ef8d29e4d..cf7677a81f8 100644 --- a/service/cognitoidentityprovider/errors.go +++ b/service/cognitoidentityprovider/errors.go @@ -13,8 +13,8 @@ const ( // // This exception is thrown when a user tries to confirm the account with an // email address or phone number that has already been supplied as an alias - // from a different account. This exception indicates that an account with this - // email address or phone already exists in a user pool that you've configured + // for a different user profile. This exception indicates that an account with + // this email address or phone already exists in a user pool that you've configured // to use email address or phone number as a sign-in alias. ErrCodeAliasExistsException = "AliasExistsException" diff --git a/service/drs/api.go b/service/drs/api.go index 3fa6a6542ad..1f078fefc51 100644 --- a/service/drs/api.go +++ b/service/drs/api.go @@ -12,6 +12,105 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/restjson" ) +const opCreateExtendedSourceServer = "CreateExtendedSourceServer" + +// CreateExtendedSourceServerRequest generates a "aws/request.Request" representing the +// client's request for the CreateExtendedSourceServer operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateExtendedSourceServer for more information on using the CreateExtendedSourceServer +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateExtendedSourceServerRequest method. +// req, resp := client.CreateExtendedSourceServerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/CreateExtendedSourceServer +func (c *Drs) CreateExtendedSourceServerRequest(input *CreateExtendedSourceServerInput) (req *request.Request, output *CreateExtendedSourceServerOutput) { + op := &request.Operation{ + Name: opCreateExtendedSourceServer, + HTTPMethod: "POST", + HTTPPath: "/CreateExtendedSourceServer", + } + + if input == nil { + input = &CreateExtendedSourceServerInput{} + } + + output = &CreateExtendedSourceServerOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateExtendedSourceServer API operation for Elastic Disaster Recovery Service. +// +// Create an extended source server in the target Account based on the source +// server in staging account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Elastic Disaster Recovery Service's +// API operation CreateExtendedSourceServer for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource for this operation was not found. +// +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ServiceQuotaExceededException +// The request could not be completed because its exceeded the service quota. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The input fails to satisfy the constraints specified by the AWS service. +// +// * UninitializedAccountException +// The account performing the request has not been initialized. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/CreateExtendedSourceServer +func (c *Drs) CreateExtendedSourceServer(input *CreateExtendedSourceServerInput) (*CreateExtendedSourceServerOutput, error) { + req, out := c.CreateExtendedSourceServerRequest(input) + return out, req.Send() +} + +// CreateExtendedSourceServerWithContext is the same as CreateExtendedSourceServer with the addition of +// the ability to pass a context and additional request options. +// +// See CreateExtendedSourceServer for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Drs) CreateExtendedSourceServerWithContext(ctx aws.Context, input *CreateExtendedSourceServerInput, opts ...request.Option) (*CreateExtendedSourceServerOutput, error) { + req, out := c.CreateExtendedSourceServerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateReplicationConfigurationTemplate = "CreateReplicationConfigurationTemplate" // CreateReplicationConfigurationTemplateRequest generates a "aws/request.Request" representing the @@ -77,7 +176,7 @@ func (c *Drs) CreateReplicationConfigurationTemplateRequest(input *CreateReplica // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -270,7 +369,7 @@ func (c *Drs) DeleteRecoveryInstanceRequest(input *DeleteRecoveryInstanceInput) // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * UninitializedAccountException // The account performing the request has not been initialized. @@ -853,7 +952,7 @@ func (c *Drs) DescribeRecoveryInstancesRequest(input *DescribeRecoveryInstancesI // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * UninitializedAccountException // The account performing the request has not been initialized. @@ -1000,7 +1099,7 @@ func (c *Drs) DescribeRecoverySnapshotsRequest(input *DescribeRecoverySnapshotsI // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -1459,7 +1558,7 @@ func (c *Drs) DisconnectRecoveryInstanceRequest(input *DisconnectRecoveryInstanc // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * UninitializedAccountException // The account performing the request has not been initialized. @@ -1833,6 +1932,9 @@ func (c *Drs) GetReplicationConfigurationRequest(input *GetReplicationConfigurat // * ThrottlingException // The request was denied due to request throttling. // +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// // * UninitializedAccountException // The account performing the request has not been initialized. // @@ -1921,7 +2023,7 @@ func (c *Drs) InitializeServiceRequest(input *InitializeServiceInput) (req *requ // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -1948,6 +2050,309 @@ func (c *Drs) InitializeServiceWithContext(ctx aws.Context, input *InitializeSer return out, req.Send() } +const opListExtensibleSourceServers = "ListExtensibleSourceServers" + +// ListExtensibleSourceServersRequest generates a "aws/request.Request" representing the +// client's request for the ListExtensibleSourceServers operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListExtensibleSourceServers for more information on using the ListExtensibleSourceServers +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListExtensibleSourceServersRequest method. +// req, resp := client.ListExtensibleSourceServersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/ListExtensibleSourceServers +func (c *Drs) ListExtensibleSourceServersRequest(input *ListExtensibleSourceServersInput) (req *request.Request, output *ListExtensibleSourceServersOutput) { + op := &request.Operation{ + Name: opListExtensibleSourceServers, + HTTPMethod: "POST", + HTTPPath: "/ListExtensibleSourceServers", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListExtensibleSourceServersInput{} + } + + output = &ListExtensibleSourceServersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListExtensibleSourceServers API operation for Elastic Disaster Recovery Service. +// +// Returns a list of source servers on a staging account that are extensible, +// which means that: a. The source server is not already extended into this +// Account. b. The source server on the Account we’re reading from is not +// an extension of another source server. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Elastic Disaster Recovery Service's +// API operation ListExtensibleSourceServers for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The input fails to satisfy the constraints specified by the AWS service. +// +// * UninitializedAccountException +// The account performing the request has not been initialized. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/ListExtensibleSourceServers +func (c *Drs) ListExtensibleSourceServers(input *ListExtensibleSourceServersInput) (*ListExtensibleSourceServersOutput, error) { + req, out := c.ListExtensibleSourceServersRequest(input) + return out, req.Send() +} + +// ListExtensibleSourceServersWithContext is the same as ListExtensibleSourceServers with the addition of +// the ability to pass a context and additional request options. +// +// See ListExtensibleSourceServers for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Drs) ListExtensibleSourceServersWithContext(ctx aws.Context, input *ListExtensibleSourceServersInput, opts ...request.Option) (*ListExtensibleSourceServersOutput, error) { + req, out := c.ListExtensibleSourceServersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListExtensibleSourceServersPages iterates over the pages of a ListExtensibleSourceServers operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListExtensibleSourceServers method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListExtensibleSourceServers operation. +// pageNum := 0 +// err := client.ListExtensibleSourceServersPages(params, +// func(page *drs.ListExtensibleSourceServersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Drs) ListExtensibleSourceServersPages(input *ListExtensibleSourceServersInput, fn func(*ListExtensibleSourceServersOutput, bool) bool) error { + return c.ListExtensibleSourceServersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListExtensibleSourceServersPagesWithContext same as ListExtensibleSourceServersPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Drs) ListExtensibleSourceServersPagesWithContext(ctx aws.Context, input *ListExtensibleSourceServersInput, fn func(*ListExtensibleSourceServersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListExtensibleSourceServersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListExtensibleSourceServersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListExtensibleSourceServersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListStagingAccounts = "ListStagingAccounts" + +// ListStagingAccountsRequest generates a "aws/request.Request" representing the +// client's request for the ListStagingAccounts operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListStagingAccounts for more information on using the ListStagingAccounts +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListStagingAccountsRequest method. +// req, resp := client.ListStagingAccountsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/ListStagingAccounts +func (c *Drs) ListStagingAccountsRequest(input *ListStagingAccountsInput) (req *request.Request, output *ListStagingAccountsOutput) { + op := &request.Operation{ + Name: opListStagingAccounts, + HTTPMethod: "GET", + HTTPPath: "/ListStagingAccounts", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListStagingAccountsInput{} + } + + output = &ListStagingAccountsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListStagingAccounts API operation for Elastic Disaster Recovery Service. +// +// Returns an array of staging accounts for existing extended source servers. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Elastic Disaster Recovery Service's +// API operation ListStagingAccounts for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The input fails to satisfy the constraints specified by the AWS service. +// +// * UninitializedAccountException +// The account performing the request has not been initialized. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/drs-2020-02-26/ListStagingAccounts +func (c *Drs) ListStagingAccounts(input *ListStagingAccountsInput) (*ListStagingAccountsOutput, error) { + req, out := c.ListStagingAccountsRequest(input) + return out, req.Send() +} + +// ListStagingAccountsWithContext is the same as ListStagingAccounts with the addition of +// the ability to pass a context and additional request options. +// +// See ListStagingAccounts for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Drs) ListStagingAccountsWithContext(ctx aws.Context, input *ListStagingAccountsInput, opts ...request.Option) (*ListStagingAccountsOutput, error) { + req, out := c.ListStagingAccountsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListStagingAccountsPages iterates over the pages of a ListStagingAccounts operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListStagingAccounts method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListStagingAccounts operation. +// pageNum := 0 +// err := client.ListStagingAccountsPages(params, +// func(page *drs.ListStagingAccountsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Drs) ListStagingAccountsPages(input *ListStagingAccountsInput, fn func(*ListStagingAccountsOutput, bool) bool) error { + return c.ListStagingAccountsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListStagingAccountsPagesWithContext same as ListStagingAccountsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Drs) ListStagingAccountsPagesWithContext(ctx aws.Context, input *ListStagingAccountsInput, fn func(*ListStagingAccountsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListStagingAccountsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListStagingAccountsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListStagingAccountsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListTagsForResource = "ListTagsForResource" // ListTagsForResourceRequest generates a "aws/request.Request" representing the @@ -2013,7 +2418,7 @@ func (c *Drs) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req * // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -2488,7 +2893,7 @@ func (c *Drs) TagResourceRequest(input *TagResourceInput) (req *request.Request, // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -2677,7 +3082,7 @@ func (c *Drs) UntagResourceRequest(input *UntagResourceInput) (req *request.Requ // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -2771,7 +3176,7 @@ func (c *Drs) UpdateFailbackReplicationConfigurationRequest(input *UpdateFailbac // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * UninitializedAccountException // The account performing the request has not been initialized. @@ -2963,7 +3368,7 @@ func (c *Drs) UpdateReplicationConfigurationRequest(input *UpdateReplicationConf // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -3058,7 +3463,7 @@ func (c *Drs) UpdateReplicationConfigurationTemplateRequest(input *UpdateReplica // The request was denied due to request throttling. // // * AccessDeniedException -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // * ValidationException // The input fails to satisfy the constraints specified by the AWS service. @@ -3088,7 +3493,7 @@ func (c *Drs) UpdateReplicationConfigurationTemplateWithContext(ctx aws.Context, return out, req.Send() } -// TYou do not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -3154,6 +3559,38 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +// AWS account. +type Account struct { + _ struct{} `type:"structure"` + + // Account ID of AWS account. + AccountID *string `locationName:"accountID" min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Account) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Account) GoString() string { + return s.String() +} + +// SetAccountID sets the AccountID field's value. +func (s *Account) SetAccountID(v string) *Account { + s.AccountID = &v + return s +} + // Information about a server's CPU. type CPU struct { _ struct{} `type:"structure"` @@ -3268,6 +3705,169 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } +// Properties of a conversion job +type ConversionProperties struct { + _ struct{} `type:"structure"` + + // The timestamp of when the snapshot being converted was taken + DataTimestamp *string `locationName:"dataTimestamp" type:"string"` + + // Whether the volume being converted uses UEFI or not + ForceUefi *bool `locationName:"forceUefi" type:"boolean"` + + // The root volume name of a conversion job + RootVolumeName *string `locationName:"rootVolumeName" type:"string"` + + // A mapping between the volumes being converted and the converted snapshot + // ids + VolumeToConversionMap map[string]map[string]*string `locationName:"volumeToConversionMap" type:"map"` + + // A mapping between the volumes and their sizes + VolumeToVolumeSize map[string]*int64 `locationName:"volumeToVolumeSize" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConversionProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConversionProperties) GoString() string { + return s.String() +} + +// SetDataTimestamp sets the DataTimestamp field's value. +func (s *ConversionProperties) SetDataTimestamp(v string) *ConversionProperties { + s.DataTimestamp = &v + return s +} + +// SetForceUefi sets the ForceUefi field's value. +func (s *ConversionProperties) SetForceUefi(v bool) *ConversionProperties { + s.ForceUefi = &v + return s +} + +// SetRootVolumeName sets the RootVolumeName field's value. +func (s *ConversionProperties) SetRootVolumeName(v string) *ConversionProperties { + s.RootVolumeName = &v + return s +} + +// SetVolumeToConversionMap sets the VolumeToConversionMap field's value. +func (s *ConversionProperties) SetVolumeToConversionMap(v map[string]map[string]*string) *ConversionProperties { + s.VolumeToConversionMap = v + return s +} + +// SetVolumeToVolumeSize sets the VolumeToVolumeSize field's value. +func (s *ConversionProperties) SetVolumeToVolumeSize(v map[string]*int64) *ConversionProperties { + s.VolumeToVolumeSize = v + return s +} + +type CreateExtendedSourceServerInput struct { + _ struct{} `type:"structure"` + + // This defines the ARN of the source server in staging Account based on which + // you want to create an extended source server. + // + // SourceServerArn is a required field + SourceServerArn *string `locationName:"sourceServerArn" min:"20" type:"string" required:"true"` + + // A list of tags associated with the extended source server. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateExtendedSourceServerInput's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExtendedSourceServerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExtendedSourceServerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateExtendedSourceServerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateExtendedSourceServerInput"} + if s.SourceServerArn == nil { + invalidParams.Add(request.NewErrParamRequired("SourceServerArn")) + } + if s.SourceServerArn != nil && len(*s.SourceServerArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("SourceServerArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSourceServerArn sets the SourceServerArn field's value. +func (s *CreateExtendedSourceServerInput) SetSourceServerArn(v string) *CreateExtendedSourceServerInput { + s.SourceServerArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateExtendedSourceServerInput) SetTags(v map[string]*string) *CreateExtendedSourceServerInput { + s.Tags = v + return s +} + +type CreateExtendedSourceServerOutput struct { + _ struct{} `type:"structure"` + + // Created extended source server. + SourceServer *SourceServer `locationName:"sourceServer" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExtendedSourceServerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExtendedSourceServerOutput) GoString() string { + return s.String() +} + +// SetSourceServer sets the SourceServer field's value. +func (s *CreateExtendedSourceServerOutput) SetSourceServer(v *SourceServer) *CreateExtendedSourceServerOutput { + s.SourceServer = v + return s +} + type CreateReplicationConfigurationTemplateInput struct { _ struct{} `type:"structure"` @@ -4371,9 +4971,7 @@ type DescribeJobsInput struct { _ struct{} `type:"structure"` // A set of filters by which to return Jobs. - // - // Filters is a required field - Filters *DescribeJobsRequestFilters `locationName:"filters" type:"structure" required:"true"` + Filters *DescribeJobsRequestFilters `locationName:"filters" type:"structure"` // Maximum number of Jobs to retrieve. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -4403,9 +5001,6 @@ func (s DescribeJobsInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeJobsInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeJobsInput"} - if s.Filters == nil { - invalidParams.Add(request.NewErrParamRequired("Filters")) - } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -4549,9 +5144,7 @@ type DescribeRecoveryInstancesInput struct { _ struct{} `type:"structure"` // A set of filters by which to return Recovery Instances. - // - // Filters is a required field - Filters *DescribeRecoveryInstancesRequestFilters `locationName:"filters" type:"structure" required:"true"` + Filters *DescribeRecoveryInstancesRequestFilters `locationName:"filters" type:"structure"` // Maximum number of Recovery Instances to retrieve. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -4581,9 +5174,6 @@ func (s DescribeRecoveryInstancesInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeRecoveryInstancesInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeRecoveryInstancesInput"} - if s.Filters == nil { - invalidParams.Add(request.NewErrParamRequired("Filters")) - } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -4896,9 +5486,7 @@ type DescribeReplicationConfigurationTemplatesInput struct { // The IDs of the Replication Configuration Templates to retrieve. An empty // list means all Replication Configuration Templates. - // - // ReplicationConfigurationTemplateIDs is a required field - ReplicationConfigurationTemplateIDs []*string `locationName:"replicationConfigurationTemplateIDs" type:"list" required:"true"` + ReplicationConfigurationTemplateIDs []*string `locationName:"replicationConfigurationTemplateIDs" type:"list"` } // String returns the string representation. @@ -4925,9 +5513,6 @@ func (s *DescribeReplicationConfigurationTemplatesInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.ReplicationConfigurationTemplateIDs == nil { - invalidParams.Add(request.NewErrParamRequired("ReplicationConfigurationTemplateIDs")) - } if invalidParams.Len() > 0 { return invalidParams @@ -4997,9 +5582,7 @@ type DescribeSourceServersInput struct { _ struct{} `type:"structure"` // A set of filters by which to return Source Servers. - // - // Filters is a required field - Filters *DescribeSourceServersRequestFilters `locationName:"filters" type:"structure" required:"true"` + Filters *DescribeSourceServersRequestFilters `locationName:"filters" type:"structure"` // Maximum number of Source Servers to retrieve. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -5029,9 +5612,6 @@ func (s DescribeSourceServersInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeSourceServersInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeSourceServersInput"} - if s.Filters == nil { - invalidParams.Add(request.NewErrParamRequired("Filters")) - } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -5111,6 +5691,10 @@ type DescribeSourceServersRequestFilters struct { // An array of Source Servers IDs that should be returned. An empty array means // all Source Servers. SourceServerIDs []*string `locationName:"sourceServerIDs" type:"list"` + + // An array of staging account IDs that extended source servers belong to. An + // empty array means all source servers will be shown. + StagingAccountIDs []*string `locationName:"stagingAccountIDs" type:"list"` } // String returns the string representation. @@ -5143,6 +5727,12 @@ func (s *DescribeSourceServersRequestFilters) SetSourceServerIDs(v []*string) *D return s } +// SetStagingAccountIDs sets the StagingAccountIDs field's value. +func (s *DescribeSourceServersRequestFilters) SetStagingAccountIDs(v []*string) *DescribeSourceServersRequestFilters { + s.StagingAccountIDs = v + return s +} + type DisconnectRecoveryInstanceInput struct { _ struct{} `type:"structure"` @@ -5287,6 +5877,9 @@ type DisconnectSourceServerOutput struct { // The ID of the Source Server. SourceServerID *string `locationName:"sourceServerID" min:"19" type:"string"` + // The staging area of the source server. + StagingArea *StagingArea `locationName:"stagingArea" type:"structure"` + // The tags associated with the Source Server. // // Tags is a sensitive parameter and its value will be @@ -5355,6 +5948,12 @@ func (s *DisconnectSourceServerOutput) SetSourceServerID(v string) *DisconnectSo return s } +// SetStagingArea sets the StagingArea field's value. +func (s *DisconnectSourceServerOutput) SetStagingArea(v *StagingArea) *DisconnectSourceServerOutput { + s.StagingArea = v + return s +} + // SetTags sets the Tags field's value. func (s *DisconnectSourceServerOutput) SetTags(v map[string]*string) *DisconnectSourceServerOutput { s.Tags = v @@ -6218,6 +6817,9 @@ func (s *JobLog) SetLogDateTime(v string) *JobLog { type JobLogEventData struct { _ struct{} `type:"structure"` + // Properties of a conversion job + ConversionProperties *ConversionProperties `locationName:"conversionProperties" type:"structure"` + // The ID of a conversion server. ConversionServerID *string `locationName:"conversionServerID" type:"string"` @@ -6249,6 +6851,12 @@ func (s JobLogEventData) GoString() string { return s.String() } +// SetConversionProperties sets the ConversionProperties field's value. +func (s *JobLogEventData) SetConversionProperties(v *ConversionProperties) *JobLogEventData { + s.ConversionProperties = v + return s +} + // SetConversionServerID sets the ConversionServerID field's value. func (s *JobLogEventData) SetConversionServerID(v string) *JobLogEventData { s.ConversionServerID = &v @@ -6458,6 +7066,209 @@ func (s *LifeCycleLastLaunchInitiated) SetType(v string) *LifeCycleLastLaunchIni return s } +type ListExtensibleSourceServersInput struct { + _ struct{} `type:"structure"` + + // The maximum number of extensible source servers to retrieve. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // The token of the next extensible source server to retrieve. + NextToken *string `locationName:"nextToken" type:"string"` + + // The Id of the staging Account to retrieve extensible source servers from. + // + // StagingAccountID is a required field + StagingAccountID *string `locationName:"stagingAccountID" min:"12" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListExtensibleSourceServersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListExtensibleSourceServersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListExtensibleSourceServersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListExtensibleSourceServersInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.StagingAccountID == nil { + invalidParams.Add(request.NewErrParamRequired("StagingAccountID")) + } + if s.StagingAccountID != nil && len(*s.StagingAccountID) < 12 { + invalidParams.Add(request.NewErrParamMinLen("StagingAccountID", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListExtensibleSourceServersInput) SetMaxResults(v int64) *ListExtensibleSourceServersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListExtensibleSourceServersInput) SetNextToken(v string) *ListExtensibleSourceServersInput { + s.NextToken = &v + return s +} + +// SetStagingAccountID sets the StagingAccountID field's value. +func (s *ListExtensibleSourceServersInput) SetStagingAccountID(v string) *ListExtensibleSourceServersInput { + s.StagingAccountID = &v + return s +} + +type ListExtensibleSourceServersOutput struct { + _ struct{} `type:"structure"` + + // A list of source servers on a staging Account that are extensible. + Items []*StagingSourceServer `locationName:"items" type:"list"` + + // The token of the next extensible source server to retrieve. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListExtensibleSourceServersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListExtensibleSourceServersOutput) GoString() string { + return s.String() +} + +// SetItems sets the Items field's value. +func (s *ListExtensibleSourceServersOutput) SetItems(v []*StagingSourceServer) *ListExtensibleSourceServersOutput { + s.Items = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListExtensibleSourceServersOutput) SetNextToken(v string) *ListExtensibleSourceServersOutput { + s.NextToken = &v + return s +} + +type ListStagingAccountsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of staging Accounts to retrieve. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token of the next staging Account to retrieve. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStagingAccountsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStagingAccountsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListStagingAccountsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListStagingAccountsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListStagingAccountsInput) SetMaxResults(v int64) *ListStagingAccountsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStagingAccountsInput) SetNextToken(v string) *ListStagingAccountsInput { + s.NextToken = &v + return s +} + +type ListStagingAccountsOutput struct { + _ struct{} `type:"structure"` + + // An array of staging AWS Accounts. + Accounts []*Account `locationName:"accounts" type:"list"` + + // The token of the next staging Account to retrieve. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStagingAccountsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStagingAccountsOutput) GoString() string { + return s.String() +} + +// SetAccounts sets the Accounts field's value. +func (s *ListStagingAccountsOutput) SetAccounts(v []*Account) *ListStagingAccountsOutput { + s.Accounts = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStagingAccountsOutput) SetNextToken(v string) *ListStagingAccountsOutput { + s.NextToken = &v + return s +} + type ListTagsForResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -7892,6 +8703,9 @@ type RetryDataReplicationOutput struct { // The ID of the Source Server. SourceServerID *string `locationName:"sourceServerID" min:"19" type:"string"` + // The staging area of the source server. + StagingArea *StagingArea `locationName:"stagingArea" type:"structure"` + // The tags associated with the Source Server. // // Tags is a sensitive parameter and its value will be @@ -7960,6 +8774,12 @@ func (s *RetryDataReplicationOutput) SetSourceServerID(v string) *RetryDataRepli return s } +// SetStagingArea sets the StagingArea field's value. +func (s *RetryDataReplicationOutput) SetStagingArea(v *StagingArea) *RetryDataReplicationOutput { + s.StagingArea = v + return s +} + // SetTags sets the Tags field's value. func (s *RetryDataReplicationOutput) SetTags(v map[string]*string) *RetryDataReplicationOutput { s.Tags = v @@ -8164,6 +8984,9 @@ type SourceServer struct { // The ID of the Source Server. SourceServerID *string `locationName:"sourceServerID" min:"19" type:"string"` + // The staging area of the source server. + StagingArea *StagingArea `locationName:"stagingArea" type:"structure"` + // The tags associated with the Source Server. // // Tags is a sensitive parameter and its value will be @@ -8232,12 +9055,139 @@ func (s *SourceServer) SetSourceServerID(v string) *SourceServer { return s } +// SetStagingArea sets the StagingArea field's value. +func (s *SourceServer) SetStagingArea(v *StagingArea) *SourceServer { + s.StagingArea = v + return s +} + // SetTags sets the Tags field's value. func (s *SourceServer) SetTags(v map[string]*string) *SourceServer { s.Tags = v return s } +// Staging information related to source server. +type StagingArea struct { + _ struct{} `type:"structure"` + + // Shows an error message that occurred when DRS tried to access the staging + // source server. In this case StagingArea$status will have value EXTENSION_ERROR + ErrorMessage *string `locationName:"errorMessage" type:"string"` + + // Account ID of the account to which source server belongs. If this source + // server is extended - shows Account ID of staging source server. + StagingAccountID *string `locationName:"stagingAccountID" min:"12" type:"string"` + + // Arn of the staging source server if this source server is extended + StagingSourceServerArn *string `locationName:"stagingSourceServerArn" min:"20" type:"string"` + + // Status of Source server extension. Possible values: (a) NOT_EXTENDED - This + // is a source server that is replicating in the current account. (b) EXTENDED + // - Source server is extended from a staging source server. In this case, the + // value of stagingSourceServerArn is pointing to the Arn of the source server + // in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing + // staging source server. In this case, errorMessage field will contain an error + // message that explains what happened. + Status *string `locationName:"status" type:"string" enum:"ExtensionStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StagingArea) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StagingArea) GoString() string { + return s.String() +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *StagingArea) SetErrorMessage(v string) *StagingArea { + s.ErrorMessage = &v + return s +} + +// SetStagingAccountID sets the StagingAccountID field's value. +func (s *StagingArea) SetStagingAccountID(v string) *StagingArea { + s.StagingAccountID = &v + return s +} + +// SetStagingSourceServerArn sets the StagingSourceServerArn field's value. +func (s *StagingArea) SetStagingSourceServerArn(v string) *StagingArea { + s.StagingSourceServerArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *StagingArea) SetStatus(v string) *StagingArea { + s.Status = &v + return s +} + +// Source server in staging account that extended source server connected to. +type StagingSourceServer struct { + _ struct{} `type:"structure"` + + // The ARN of the source server. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // Hostname of staging source server. + Hostname *string `locationName:"hostname" type:"string"` + + // A list of tags associated with the staging source server. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StagingSourceServer's + // String and GoString methods. + Tags map[string]*string `locationName:"tags" type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StagingSourceServer) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StagingSourceServer) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *StagingSourceServer) SetArn(v string) *StagingSourceServer { + s.Arn = &v + return s +} + +// SetHostname sets the Hostname field's value. +func (s *StagingSourceServer) SetHostname(v string) *StagingSourceServer { + s.Hostname = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *StagingSourceServer) SetTags(v map[string]*string) *StagingSourceServer { + s.Tags = v + return s +} + type StartFailbackLaunchInput struct { _ struct{} `type:"structure"` @@ -10383,6 +11333,26 @@ func EC2InstanceState_Values() []string { } } +const ( + // ExtensionStatusExtended is a ExtensionStatus enum value + ExtensionStatusExtended = "EXTENDED" + + // ExtensionStatusExtensionError is a ExtensionStatus enum value + ExtensionStatusExtensionError = "EXTENSION_ERROR" + + // ExtensionStatusNotExtended is a ExtensionStatus enum value + ExtensionStatusNotExtended = "NOT_EXTENDED" +) + +// ExtensionStatus_Values returns all elements of the ExtensionStatus enum +func ExtensionStatus_Values() []string { + return []string{ + ExtensionStatusExtended, + ExtensionStatusExtensionError, + ExtensionStatusNotExtended, + } +} + const ( // FailbackReplicationErrorAgentNotSeen is a FailbackReplicationError enum value FailbackReplicationErrorAgentNotSeen = "AGENT_NOT_SEEN" @@ -10470,6 +11440,9 @@ const ( // InitiatedByTerminateRecoveryInstances is a InitiatedBy enum value InitiatedByTerminateRecoveryInstances = "TERMINATE_RECOVERY_INSTANCES" + + // InitiatedByTargetAccount is a InitiatedBy enum value + InitiatedByTargetAccount = "TARGET_ACCOUNT" ) // InitiatedBy_Values returns all elements of the InitiatedBy enum @@ -10480,6 +11453,7 @@ func InitiatedBy_Values() []string { InitiatedByFailback, InitiatedByDiagnostic, InitiatedByTerminateRecoveryInstances, + InitiatedByTargetAccount, } } @@ -10585,6 +11559,9 @@ const ( // JobTypeTerminate is a JobType enum value JobTypeTerminate = "TERMINATE" + + // JobTypeCreateConvertedSnapshot is a JobType enum value + JobTypeCreateConvertedSnapshot = "CREATE_CONVERTED_SNAPSHOT" ) // JobType_Values returns all elements of the JobType enum @@ -10592,6 +11569,7 @@ func JobType_Values() []string { return []string{ JobTypeLaunch, JobTypeTerminate, + JobTypeCreateConvertedSnapshot, } } diff --git a/service/drs/drsiface/interface.go b/service/drs/drsiface/interface.go index c640e8bf6b3..4290a31d887 100644 --- a/service/drs/drsiface/interface.go +++ b/service/drs/drsiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // Elastic Disaster Recovery Service. // func myFunc(svc drsiface.DrsAPI) bool { -// // Make svc.CreateReplicationConfigurationTemplate request +// // Make svc.CreateExtendedSourceServer request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockDrsClient struct { // drsiface.DrsAPI // } -// func (m *mockDrsClient) CreateReplicationConfigurationTemplate(input *drs.CreateReplicationConfigurationTemplateInput) (*drs.CreateReplicationConfigurationTemplateOutput, error) { +// func (m *mockDrsClient) CreateExtendedSourceServer(input *drs.CreateExtendedSourceServerInput) (*drs.CreateExtendedSourceServerOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,10 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type DrsAPI interface { + CreateExtendedSourceServer(*drs.CreateExtendedSourceServerInput) (*drs.CreateExtendedSourceServerOutput, error) + CreateExtendedSourceServerWithContext(aws.Context, *drs.CreateExtendedSourceServerInput, ...request.Option) (*drs.CreateExtendedSourceServerOutput, error) + CreateExtendedSourceServerRequest(*drs.CreateExtendedSourceServerInput) (*request.Request, *drs.CreateExtendedSourceServerOutput) + CreateReplicationConfigurationTemplate(*drs.CreateReplicationConfigurationTemplateInput) (*drs.CreateReplicationConfigurationTemplateOutput, error) CreateReplicationConfigurationTemplateWithContext(aws.Context, *drs.CreateReplicationConfigurationTemplateInput, ...request.Option) (*drs.CreateReplicationConfigurationTemplateOutput, error) CreateReplicationConfigurationTemplateRequest(*drs.CreateReplicationConfigurationTemplateInput) (*request.Request, *drs.CreateReplicationConfigurationTemplateOutput) @@ -146,6 +150,20 @@ type DrsAPI interface { InitializeServiceWithContext(aws.Context, *drs.InitializeServiceInput, ...request.Option) (*drs.InitializeServiceOutput, error) InitializeServiceRequest(*drs.InitializeServiceInput) (*request.Request, *drs.InitializeServiceOutput) + ListExtensibleSourceServers(*drs.ListExtensibleSourceServersInput) (*drs.ListExtensibleSourceServersOutput, error) + ListExtensibleSourceServersWithContext(aws.Context, *drs.ListExtensibleSourceServersInput, ...request.Option) (*drs.ListExtensibleSourceServersOutput, error) + ListExtensibleSourceServersRequest(*drs.ListExtensibleSourceServersInput) (*request.Request, *drs.ListExtensibleSourceServersOutput) + + ListExtensibleSourceServersPages(*drs.ListExtensibleSourceServersInput, func(*drs.ListExtensibleSourceServersOutput, bool) bool) error + ListExtensibleSourceServersPagesWithContext(aws.Context, *drs.ListExtensibleSourceServersInput, func(*drs.ListExtensibleSourceServersOutput, bool) bool, ...request.Option) error + + ListStagingAccounts(*drs.ListStagingAccountsInput) (*drs.ListStagingAccountsOutput, error) + ListStagingAccountsWithContext(aws.Context, *drs.ListStagingAccountsInput, ...request.Option) (*drs.ListStagingAccountsOutput, error) + ListStagingAccountsRequest(*drs.ListStagingAccountsInput) (*request.Request, *drs.ListStagingAccountsOutput) + + ListStagingAccountsPages(*drs.ListStagingAccountsInput, func(*drs.ListStagingAccountsOutput, bool) bool) error + ListStagingAccountsPagesWithContext(aws.Context, *drs.ListStagingAccountsInput, func(*drs.ListStagingAccountsOutput, bool) bool, ...request.Option) error + ListTagsForResource(*drs.ListTagsForResourceInput) (*drs.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *drs.ListTagsForResourceInput, ...request.Option) (*drs.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*drs.ListTagsForResourceInput) (*request.Request, *drs.ListTagsForResourceOutput) diff --git a/service/drs/errors.go b/service/drs/errors.go index 8477502bb85..67aa921b156 100644 --- a/service/drs/errors.go +++ b/service/drs/errors.go @@ -11,7 +11,7 @@ const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // - // TYou do not have sufficient access to perform this action. + // You do not have sufficient access to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code diff --git a/service/iotsitewise/api.go b/service/iotsitewise/api.go index ce0913b1bdf..6741b1e6f8d 100644 --- a/service/iotsitewise/api.go +++ b/service/iotsitewise/api.go @@ -9531,6 +9531,9 @@ type AssetSummary struct { // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` + // A description for the asset. + Description *string `locationName:"description" min:"1" type:"string"` + // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // @@ -9594,6 +9597,12 @@ func (s *AssetSummary) SetCreationDate(v time.Time) *AssetSummary { return s } +// SetDescription sets the Description field's value. +func (s *AssetSummary) SetDescription(v string) *AssetSummary { + s.Description = &v + return s +} + // SetHierarchies sets the Hierarchies field's value. func (s *AssetSummary) SetHierarchies(v []*AssetHierarchy) *AssetSummary { s.Hierarchies = v @@ -9887,6 +9896,9 @@ type AssociatedAssetsSummary struct { // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` + // A description for the asset. + Description *string `locationName:"description" min:"1" type:"string"` + // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // @@ -9950,6 +9962,12 @@ func (s *AssociatedAssetsSummary) SetCreationDate(v time.Time) *AssociatedAssets return s } +// SetDescription sets the Description field's value. +func (s *AssociatedAssetsSummary) SetDescription(v string) *AssociatedAssetsSummary { + s.Description = &v + return s +} + // SetHierarchies sets the Hierarchies field's value. func (s *AssociatedAssetsSummary) SetHierarchies(v []*AssetHierarchy) *AssociatedAssetsSummary { s.Hierarchies = v @@ -12332,6 +12350,9 @@ func (s *CreateAccessPolicyOutput) SetAccessPolicyId(v string) *CreateAccessPoli type CreateAssetInput struct { _ struct{} `type:"structure"` + // A description for the asset. + AssetDescription *string `locationName:"assetDescription" min:"1" type:"string"` + // The ID of the asset model from which to create the asset. // // AssetModelId is a required field @@ -12374,6 +12395,9 @@ func (s CreateAssetInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateAssetInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateAssetInput"} + if s.AssetDescription != nil && len(*s.AssetDescription) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AssetDescription", 1)) + } if s.AssetModelId == nil { invalidParams.Add(request.NewErrParamRequired("AssetModelId")) } @@ -12399,6 +12423,12 @@ func (s *CreateAssetInput) Validate() error { return nil } +// SetAssetDescription sets the AssetDescription field's value. +func (s *CreateAssetInput) SetAssetDescription(v string) *CreateAssetInput { + s.AssetDescription = &v + return s +} + // SetAssetModelId sets the AssetModelId field's value. func (s *CreateAssetInput) SetAssetModelId(v string) *CreateAssetInput { s.AssetModelId = &v @@ -14718,6 +14748,9 @@ type DescribeAssetOutput struct { // AssetCreationDate is a required field AssetCreationDate *time.Time `locationName:"assetCreationDate" type:"timestamp" required:"true"` + // A description for the asset. + AssetDescription *string `locationName:"assetDescription" min:"1" type:"string"` + // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // @@ -14794,6 +14827,12 @@ func (s *DescribeAssetOutput) SetAssetCreationDate(v time.Time) *DescribeAssetOu return s } +// SetAssetDescription sets the AssetDescription field's value. +func (s *DescribeAssetOutput) SetAssetDescription(v string) *DescribeAssetOutput { + s.AssetDescription = &v + return s +} + // SetAssetHierarchies sets the AssetHierarchies field's value. func (s *DescribeAssetOutput) SetAssetHierarchies(v []*AssetHierarchy) *DescribeAssetOutput { s.AssetHierarchies = v @@ -16018,8 +16057,7 @@ type DescribeStorageConfigurationOutput struct { // tier. The hot tier is a service-managed database. // // * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold - // tier and the cold tier. The cold tier is a customer-managed Amazon S3 - // bucket. + // tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket. // // StorageType is a required field StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"` @@ -21337,8 +21375,7 @@ type PutStorageConfigurationInput struct { // tier. The hot tier is a service-managed database. // // * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold - // tier and the cold tier. The cold tier is a customer-managed Amazon S3 - // bucket. + // tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket. // // StorageType is a required field StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"` @@ -21446,8 +21483,7 @@ type PutStorageConfigurationOutput struct { // tier. The hot tier is a service-managed database. // // * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold - // tier and the cold tier. The cold tier is a customer-managed Amazon S3 - // bucket. + // tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket. // // StorageType is a required field StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"` @@ -22793,6 +22829,9 @@ func (s UpdateAccessPolicyOutput) GoString() string { type UpdateAssetInput struct { _ struct{} `type:"structure"` + // A description for the asset. + AssetDescription *string `locationName:"assetDescription" min:"1" type:"string"` + // The ID of the asset to update. // // AssetId is a required field @@ -22830,6 +22869,9 @@ func (s UpdateAssetInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *UpdateAssetInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "UpdateAssetInput"} + if s.AssetDescription != nil && len(*s.AssetDescription) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AssetDescription", 1)) + } if s.AssetId == nil { invalidParams.Add(request.NewErrParamRequired("AssetId")) } @@ -22852,6 +22894,12 @@ func (s *UpdateAssetInput) Validate() error { return nil } +// SetAssetDescription sets the AssetDescription field's value. +func (s *UpdateAssetInput) SetAssetDescription(v string) *UpdateAssetInput { + s.AssetDescription = &v + return s +} + // SetAssetId sets the AssetId field's value. func (s *UpdateAssetInput) SetAssetId(v string) *UpdateAssetInput { s.AssetId = &v diff --git a/service/lookoutmetrics/api.go b/service/lookoutmetrics/api.go index a42ee86fcee..7dde33662af 100644 --- a/service/lookoutmetrics/api.go +++ b/service/lookoutmetrics/api.go @@ -4529,6 +4529,9 @@ func (s *BackTestConfiguration) SetRunBackTestMode(v bool) *BackTestConfiguratio type CloudWatchConfig struct { _ struct{} `type:"structure"` + // Settings for backtest mode. + BackTestConfiguration *BackTestConfiguration `type:"structure"` + // An IAM role that gives Amazon Lookout for Metrics permission to access data // in Amazon CloudWatch. RoleArn *string `type:"string"` @@ -4552,6 +4555,27 @@ func (s CloudWatchConfig) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *CloudWatchConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CloudWatchConfig"} + if s.BackTestConfiguration != nil { + if err := s.BackTestConfiguration.Validate(); err != nil { + invalidParams.AddNested("BackTestConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBackTestConfiguration sets the BackTestConfiguration field's value. +func (s *CloudWatchConfig) SetBackTestConfiguration(v *BackTestConfiguration) *CloudWatchConfig { + s.BackTestConfiguration = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *CloudWatchConfig) SetRoleArn(v string) *CloudWatchConfig { s.RoleArn = &v @@ -8291,6 +8315,11 @@ func (s *MetricSource) Validate() error { invalidParams.AddNested("AthenaSourceConfig", err.(request.ErrInvalidParams)) } } + if s.CloudWatchConfig != nil { + if err := s.CloudWatchConfig.Validate(); err != nil { + invalidParams.AddNested("CloudWatchConfig", err.(request.ErrInvalidParams)) + } + } if s.RDSSourceConfig != nil { if err := s.RDSSourceConfig.Validate(); err != nil { invalidParams.AddNested("RDSSourceConfig", err.(request.ErrInvalidParams)) diff --git a/service/transcribeservice/api.go b/service/transcribeservice/api.go index 273fcbaf356..8a7dfc624ef 100644 --- a/service/transcribeservice/api.go +++ b/service/transcribeservice/api.go @@ -57,14 +57,27 @@ func (c *TranscribeService) CreateCallAnalyticsCategoryRequest(input *CreateCall // CreateCallAnalyticsCategory API operation for Amazon Transcribe Service. // -// Creates a call analytics category. Amazon Transcribe applies the conditions -// specified by your call analytics categories to your call analytics jobs. -// For each analytics category, you must create between 1 and 20 rules. For -// example, you can create a 'greeting' category with a rule that flags calls -// in which your agent does not use a specified phrase (for example: "Please -// note this call may be recorded.") in the first 15 seconds of the call. When -// you start a call analytics job, Amazon Transcribe applies all your existing -// call analytics categories to that job. +// Creates a new Call Analytics category. +// +// All categories are automatically applied to your Call Analytics jobs. Note +// that in order to apply your categories to your jobs, you must create them +// before submitting your job request, as categories cannot be applied retroactively. +// +// Call Analytics categories are composed of rules. For each category, you must +// create between 1 and 20 rules. Rules can include these parameters: , , , +// and . +// +// To update an existing category, see . +// +// To learn more about: +// +// * Call Analytics categories, see Creating categories (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html) +// +// * Using rules, see Rule criteria (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules) +// and refer to the data type +// +// * Call Analytics, see Analyzing call center audio with Call Analytics +// (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -75,21 +88,22 @@ func (c *TranscribeService) CreateCallAnalyticsCategoryRequest(input *CreateCall // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategory func (c *TranscribeService) CreateCallAnalyticsCategory(input *CreateCallAnalyticsCategoryInput) (*CreateCallAnalyticsCategoryOutput, error) { @@ -157,11 +171,21 @@ func (c *TranscribeService) CreateLanguageModelRequest(input *CreateLanguageMode // CreateLanguageModel API operation for Amazon Transcribe Service. // -// Creates a new custom language model. When creating a new language model, -// you must specify if you want a Wideband (audio sample rates over 16,000 Hz) -// or Narrowband (audio sample rates under 16,000 Hz) base model. You then include -// the S3 URI location of your training and tuning files, the language for the -// model, a unique name, and any tags you want associated with your model. +// Creates a new custom language model. +// +// When creating a new language model, you must specify: +// +// * If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband +// (audio sample rates under 16,000 Hz) base model +// +// * The location of your training and tuning files (this must be an Amazon +// S3 URI) +// +// * The language of your model +// +// * A unique name for your model +// +// For more information, see Custom language models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -172,21 +196,22 @@ func (c *TranscribeService) CreateLanguageModelRequest(input *CreateLanguageMode // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateLanguageModel func (c *TranscribeService) CreateLanguageModel(input *CreateLanguageModelInput) (*CreateLanguageModelOutput, error) { @@ -256,14 +281,18 @@ func (c *TranscribeService) CreateMedicalVocabularyRequest(input *CreateMedicalV // // Creates a new custom medical vocabulary. // -// When creating a new medical vocabulary, you must upload a text file that -// contains your new entries, phrases, and terms into an S3 bucket. Note that -// this differs from , where you can include a list of terms within your request -// using the Phrases flag, as CreateMedicalVocabulary does not support the Phrases -// flag. +// Prior to creating a new medical vocabulary, you must first upload a text +// file that contains your new entries, phrases, and terms into an Amazon S3 +// bucket. Note that this differs from , where you can include a list of terms +// within your request using the Phrases flag; CreateMedicalVocabulary does +// not support the Phrases flag. +// +// Each language has a character set that contains all allowed characters for +// that specific language. If you use unsupported characters, your vocabulary +// request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) +// to get the character set for your language. // -// For more information on creating a custom vocabulary text file, see Creating -// a custom vocabulary (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html). +// For more information, see Creating a custom vocabulary (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -274,21 +303,22 @@ func (c *TranscribeService) CreateMedicalVocabularyRequest(input *CreateMedicalV // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabulary func (c *TranscribeService) CreateMedicalVocabulary(input *CreateMedicalVocabularyInput) (*CreateMedicalVocabularyOutput, error) { @@ -358,12 +388,17 @@ func (c *TranscribeService) CreateVocabularyRequest(input *CreateVocabularyInput // // Creates a new custom vocabulary. // -// When creating a new medical vocabulary, you can either upload a text file -// that contains your new entries, phrases, and terms into an S3 bucket or include -// a list of terms directly in your request using the Phrases flag. +// When creating a new vocabulary, you can either upload a text file that contains +// your new entries, phrases, and terms into an Amazon S3 bucket and include +// the URI in your request, or you can include a list of terms directly in your +// request using the Phrases flag. // -// For more information on creating a custom vocabulary, see Creating a custom -// vocabulary (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html). +// Each language has a character set that contains all allowed characters for +// that specific language. If you use unsupported characters, your vocabulary +// request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) +// to get the character set for your language. +// +// For more information, see Creating a custom vocabulary (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -374,21 +409,22 @@ func (c *TranscribeService) CreateVocabularyRequest(input *CreateVocabularyInput // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabulary func (c *TranscribeService) CreateVocabulary(input *CreateVocabularyInput) (*CreateVocabularyOutput, error) { @@ -456,9 +492,19 @@ func (c *TranscribeService) CreateVocabularyFilterRequest(input *CreateVocabular // CreateVocabularyFilter API operation for Amazon Transcribe Service. // -// Creates a new vocabulary filter that you can use to filter words from your -// transcription output. For example, you can use this operation to remove profanity -// from your transcript. +// Creates a new custom vocabulary filter. +// +// You can use vocabulary filters to mask, delete, or flag specific words from +// your transcript. Vocabulary filters are commonly used to mask profanity in +// transcripts. +// +// Each language has a character set that contains all allowed characters for +// that specific language. If you use unsupported characters, your vocabulary +// filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) +// to get the character set for your language. +// +// For more information, see Using vocabulary filtering with unwanted words +// (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -469,21 +515,22 @@ func (c *TranscribeService) CreateVocabularyFilterRequest(input *CreateVocabular // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilter func (c *TranscribeService) CreateVocabularyFilter(input *CreateVocabularyFilterInput) (*CreateVocabularyFilterOutput, error) { @@ -552,8 +599,9 @@ func (c *TranscribeService) DeleteCallAnalyticsCategoryRequest(input *DeleteCall // DeleteCallAnalyticsCategory API operation for Amazon Transcribe Service. // -// Deletes a call analytics category. To use this operation, specify the name -// of the category you want to delete using CategoryName. +// Deletes a Call Analytics category. To use this operation, specify the name +// of the category you want to delete using CategoryName. Category names are +// case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -564,22 +612,22 @@ func (c *TranscribeService) DeleteCallAnalyticsCategoryRequest(input *DeleteCall // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsCategory func (c *TranscribeService) DeleteCallAnalyticsCategory(input *DeleteCallAnalyticsCategoryInput) (*DeleteCallAnalyticsCategoryOutput, error) { @@ -648,8 +696,9 @@ func (c *TranscribeService) DeleteCallAnalyticsJobRequest(input *DeleteCallAnaly // DeleteCallAnalyticsJob API operation for Amazon Transcribe Service. // -// Deletes a call analytics job. To use this operation, specify the name of -// the job you want to delete using CallAnalyticsJobName. +// Deletes a Call Analytics job. To use this operation, specify the name of +// the job you want to delete using CallAnalyticsJobName. Job names are case +// sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -660,18 +709,18 @@ func (c *TranscribeService) DeleteCallAnalyticsJobRequest(input *DeleteCallAnaly // // Returned Error Types: // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteCallAnalyticsJob func (c *TranscribeService) DeleteCallAnalyticsJob(input *DeleteCallAnalyticsJobInput) (*DeleteCallAnalyticsJobOutput, error) { @@ -741,7 +790,8 @@ func (c *TranscribeService) DeleteLanguageModelRequest(input *DeleteLanguageMode // DeleteLanguageModel API operation for Amazon Transcribe Service. // // Deletes a custom language model. To use this operation, specify the name -// of the language model you want to delete using ModelName. +// of the language model you want to delete using ModelName. Language model +// names are case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -752,18 +802,18 @@ func (c *TranscribeService) DeleteLanguageModelRequest(input *DeleteLanguageMode // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteLanguageModel func (c *TranscribeService) DeleteLanguageModel(input *DeleteLanguageModelInput) (*DeleteLanguageModelOutput, error) { @@ -832,9 +882,9 @@ func (c *TranscribeService) DeleteMedicalTranscriptionJobRequest(input *DeleteMe // DeleteMedicalTranscriptionJob API operation for Amazon Transcribe Service. // -// Deletes a medical transcription job, along with any related information. -// To use this operation, specify the name of the job you want to delete using -// MedicalTranscriptionJobName. +// Deletes a medical transcription job. To use this operation, specify the name +// of the job you want to delete using MedicalTranscriptionJobName. Job names +// are case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -845,18 +895,18 @@ func (c *TranscribeService) DeleteMedicalTranscriptionJobRequest(input *DeleteMe // // Returned Error Types: // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJob func (c *TranscribeService) DeleteMedicalTranscriptionJob(input *DeleteMedicalTranscriptionJobInput) (*DeleteMedicalTranscriptionJobOutput, error) { @@ -926,7 +976,8 @@ func (c *TranscribeService) DeleteMedicalVocabularyRequest(input *DeleteMedicalV // DeleteMedicalVocabulary API operation for Amazon Transcribe Service. // // Deletes a custom medical vocabulary. To use this operation, specify the name -// of the vocabulary you want to delete using VocabularyName. +// of the vocabulary you want to delete using VocabularyName. Vocabulary names +// are case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -937,22 +988,22 @@ func (c *TranscribeService) DeleteMedicalVocabularyRequest(input *DeleteMedicalV // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabulary func (c *TranscribeService) DeleteMedicalVocabulary(input *DeleteMedicalVocabularyInput) (*DeleteMedicalVocabularyOutput, error) { @@ -1021,8 +1072,8 @@ func (c *TranscribeService) DeleteTranscriptionJobRequest(input *DeleteTranscrip // DeleteTranscriptionJob API operation for Amazon Transcribe Service. // -// Deletes a transcription job, along with any related information. To use this -// operation, specify the name of the job you want to delete using TranscriptionJobName. +// Deletes a transcription job. To use this operation, specify the name of the +// job you want to delete using TranscriptionJobName. Job names are case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1033,18 +1084,18 @@ func (c *TranscribeService) DeleteTranscriptionJobRequest(input *DeleteTranscrip // // Returned Error Types: // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteTranscriptionJob func (c *TranscribeService) DeleteTranscriptionJob(input *DeleteTranscriptionJobInput) (*DeleteTranscriptionJobOutput, error) { @@ -1114,7 +1165,8 @@ func (c *TranscribeService) DeleteVocabularyRequest(input *DeleteVocabularyInput // DeleteVocabulary API operation for Amazon Transcribe Service. // // Deletes a custom vocabulary. To use this operation, specify the name of the -// vocabulary you want to delete using VocabularyName. +// vocabulary you want to delete using VocabularyName. Vocabulary names are +// case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1125,22 +1177,22 @@ func (c *TranscribeService) DeleteVocabularyRequest(input *DeleteVocabularyInput // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabulary func (c *TranscribeService) DeleteVocabulary(input *DeleteVocabularyInput) (*DeleteVocabularyOutput, error) { @@ -1210,7 +1262,8 @@ func (c *TranscribeService) DeleteVocabularyFilterRequest(input *DeleteVocabular // DeleteVocabularyFilter API operation for Amazon Transcribe Service. // // Deletes a vocabulary filter. To use this operation, specify the name of the -// vocabulary filter you want to delete using VocabularyFilterName. +// vocabulary filter you want to delete using VocabularyFilterName. Vocabulary +// filter names are case sensitive. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1221,22 +1274,22 @@ func (c *TranscribeService) DeleteVocabularyFilterRequest(input *DeleteVocabular // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyFilter func (c *TranscribeService) DeleteVocabularyFilter(input *DeleteVocabularyFilterInput) (*DeleteVocabularyFilterOutput, error) { @@ -1304,8 +1357,7 @@ func (c *TranscribeService) DescribeLanguageModelRequest(input *DescribeLanguage // DescribeLanguageModel API operation for Amazon Transcribe Service. // -// Provides information about a specific custom language model in your Amazon -// Web Services account. +// Provides information about the specified custom language model. // // This operation also shows if the base language model you used to create your // custom language model has been updated. If Amazon Transcribe has updated @@ -1313,7 +1365,10 @@ func (c *TranscribeService) DescribeLanguageModelRequest(input *DescribeLanguage // base model. // // If you tried to create a new custom language model and the request wasn't -// successful, you can use this operation to help identify the reason. +// successful, you can use DescribeLanguageModel to help identify the reason +// for this failure. +// +// To get a list of your custom language models, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1324,22 +1379,22 @@ func (c *TranscribeService) DescribeLanguageModelRequest(input *DescribeLanguage // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DescribeLanguageModel func (c *TranscribeService) DescribeLanguageModel(input *DescribeLanguageModelInput) (*DescribeLanguageModelOutput, error) { @@ -1407,7 +1462,9 @@ func (c *TranscribeService) GetCallAnalyticsCategoryRequest(input *GetCallAnalyt // GetCallAnalyticsCategory API operation for Amazon Transcribe Service. // -// Retrieves information about a call analytics category. +// Provides information about the specified Call Analytics category. +// +// To get a list of your Call Analytics categories, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1418,22 +1475,22 @@ func (c *TranscribeService) GetCallAnalyticsCategoryRequest(input *GetCallAnalyt // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategory func (c *TranscribeService) GetCallAnalyticsCategory(input *GetCallAnalyticsCategoryInput) (*GetCallAnalyticsCategoryOutput, error) { @@ -1501,13 +1558,20 @@ func (c *TranscribeService) GetCallAnalyticsJobRequest(input *GetCallAnalyticsJo // GetCallAnalyticsJob API operation for Amazon Transcribe Service. // -// Retrieves information about a call analytics job. +// Provides information about the specified Call Analytics job. // -// To view the job's status, refer to the CallAnalyticsJobStatus field. If the -// status is COMPLETED, the job is finished. You can then find your transcript -// at the URI specified in the TranscriptFileUri field. If you enabled personally -// identifiable information (PII) redaction, the redacted transcript appears -// in the RedactedTranscriptFileUri field. +// To view the job's status, refer to CallAnalyticsJobStatus. If the status +// is COMPLETED, the job is finished. You can find your completed transcript +// at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason +// provides details on why your transcription job failed. +// +// If you enabled personally identifiable information (PII) redaction, the redacted +// transcript appears at the location specified in RedactedTranscriptFileUri. +// +// If you chose to redact the audio in your media file, you can find your redacted +// media file at the location specified in RedactedMediaFileUri. +// +// To get a list of your Call Analytics jobs, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1518,22 +1582,22 @@ func (c *TranscribeService) GetCallAnalyticsJobRequest(input *GetCallAnalyticsJo // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsJob func (c *TranscribeService) GetCallAnalyticsJob(input *GetCallAnalyticsJobInput) (*GetCallAnalyticsJobOutput, error) { @@ -1601,11 +1665,15 @@ func (c *TranscribeService) GetMedicalTranscriptionJobRequest(input *GetMedicalT // GetMedicalTranscriptionJob API operation for Amazon Transcribe Service. // -// Retrieves information about a medical transcription job. +// Provides information about the specified medical transcription job. // -// To view the job's status, refer to the TranscriptionJobStatus field. If the -// status is COMPLETED, the job is finished. You can then find your transcript -// at the URI specified in the TranscriptFileUri field. +// To view the status of the specified medical transcription job, check the +// TranscriptionJobStatus field. If the status is COMPLETED, the job is finished +// and you can find the results at the location specified in TranscriptFileUri. +// If the status is FAILED, FailureReason provides details on why your transcription +// job failed. +// +// To get a list of your medical transcription jobs, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1616,22 +1684,22 @@ func (c *TranscribeService) GetMedicalTranscriptionJobRequest(input *GetMedicalT // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJob func (c *TranscribeService) GetMedicalTranscriptionJob(input *GetMedicalTranscriptionJobInput) (*GetMedicalTranscriptionJobOutput, error) { @@ -1699,7 +1767,13 @@ func (c *TranscribeService) GetMedicalVocabularyRequest(input *GetMedicalVocabul // GetMedicalVocabulary API operation for Amazon Transcribe Service. // -// Retrieves information about a medical vocabulary. +// Provides information about the specified custom medical vocabulary. +// +// To view the status of the specified medical vocabulary, check the VocabularyState +// field. If the status is READY, your vocabulary is available to use. If the +// status is FAILED, FailureReason provides details on why your vocabulary failed. +// +// To get a list of your custom medical vocabularies, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1710,22 +1784,22 @@ func (c *TranscribeService) GetMedicalVocabularyRequest(input *GetMedicalVocabul // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabulary func (c *TranscribeService) GetMedicalVocabulary(input *GetMedicalVocabularyInput) (*GetMedicalVocabularyOutput, error) { @@ -1793,11 +1867,17 @@ func (c *TranscribeService) GetTranscriptionJobRequest(input *GetTranscriptionJo // GetTranscriptionJob API operation for Amazon Transcribe Service. // -// Returns information about a transcription job. To see the status of the job, -// check the TranscriptionJobStatus field. If the status is COMPLETED, the job -// is finished and you can find the results at the location specified in the -// TranscriptFileUri field. If you enable content redaction, the redacted transcript -// appears in RedactedTranscriptFileUri. +// Provides information about the specified transcription job. +// +// To view the status of the specified transcription job, check the TranscriptionJobStatus +// field. If the status is COMPLETED, the job is finished and you can find the +// results at the location specified in TranscriptFileUri. If the status is +// FAILED, FailureReason provides details on why your transcription job failed. +// +// If you enabled content redaction, the redacted transcript can be found at +// the location specified in RedactedTranscriptFileUri. +// +// To get a list of your transcription jobs, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1808,22 +1888,22 @@ func (c *TranscribeService) GetTranscriptionJobRequest(input *GetTranscriptionJo // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetTranscriptionJob func (c *TranscribeService) GetTranscriptionJob(input *GetTranscriptionJobInput) (*GetTranscriptionJobOutput, error) { @@ -1891,7 +1971,13 @@ func (c *TranscribeService) GetVocabularyRequest(input *GetVocabularyInput) (req // GetVocabulary API operation for Amazon Transcribe Service. // -// Gets information about a vocabulary. +// Provides information about the specified custom vocabulary. +// +// To view the status of the specified vocabulary, check the VocabularyState +// field. If the status is READY, your vocabulary is available to use. If the +// status is FAILED, FailureReason provides details on why your vocabulary failed. +// +// To get a list of your custom vocabularies, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1902,22 +1988,22 @@ func (c *TranscribeService) GetVocabularyRequest(input *GetVocabularyInput) (req // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabulary func (c *TranscribeService) GetVocabulary(input *GetVocabularyInput) (*GetVocabularyOutput, error) { @@ -1985,7 +2071,14 @@ func (c *TranscribeService) GetVocabularyFilterRequest(input *GetVocabularyFilte // GetVocabularyFilter API operation for Amazon Transcribe Service. // -// Returns information about a vocabulary filter. +// Provides information about the specified custom vocabulary filter. +// +// To view the status of the specified vocabulary filter, check the VocabularyState +// field. If the status is READY, your vocabulary is available to use. If the +// status is FAILED, FailureReason provides details on why your vocabulary filter +// failed. +// +// To get a list of your custom vocabulary filters, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1996,22 +2089,22 @@ func (c *TranscribeService) GetVocabularyFilterRequest(input *GetVocabularyFilte // // Returned Error Types: // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilter func (c *TranscribeService) GetVocabularyFilter(input *GetVocabularyFilterInput) (*GetVocabularyFilterOutput, error) { @@ -2085,9 +2178,11 @@ func (c *TranscribeService) ListCallAnalyticsCategoriesRequest(input *ListCallAn // ListCallAnalyticsCategories API operation for Amazon Transcribe Service. // -// Provides more information about the call analytics categories that you've -// created. You can use the information in this list to find a specific category. -// You can then use the operation to get more information about it. +// Provides a list of Call Analytics categories, including all rules that make +// up each category. +// +// To get detailed information about a specific Call Analytics category, use +// the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2098,18 +2193,18 @@ func (c *TranscribeService) ListCallAnalyticsCategoriesRequest(input *ListCallAn // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategories func (c *TranscribeService) ListCallAnalyticsCategories(input *ListCallAnalyticsCategoriesInput) (*ListCallAnalyticsCategoriesOutput, error) { @@ -2235,8 +2330,11 @@ func (c *TranscribeService) ListCallAnalyticsJobsRequest(input *ListCallAnalytic // ListCallAnalyticsJobs API operation for Amazon Transcribe Service. // -// List call analytics jobs with a specified status or substring that matches -// their names. +// Provides a list of Call Analytics jobs that match the specified criteria. +// If no criteria are specified, all Call Analytics jobs are returned. +// +// To get detailed information about a specific Call Analytics job, use the +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2247,18 +2345,18 @@ func (c *TranscribeService) ListCallAnalyticsJobsRequest(input *ListCallAnalytic // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobs func (c *TranscribeService) ListCallAnalyticsJobs(input *ListCallAnalyticsJobsInput) (*ListCallAnalyticsJobsOutput, error) { @@ -2384,9 +2482,11 @@ func (c *TranscribeService) ListLanguageModelsRequest(input *ListLanguageModelsI // ListLanguageModels API operation for Amazon Transcribe Service. // -// Provides more information about the custom language models you've created. -// You can use the information in this list to find a specific custom language -// model. You can then use the operation to get more information about it. +// Provides a list of custom language models that match the specified criteria. +// If no criteria are specified, all language models are returned. +// +// To get detailed information about a specific custom language model, use the +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2397,18 +2497,18 @@ func (c *TranscribeService) ListLanguageModelsRequest(input *ListLanguageModelsI // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModels func (c *TranscribeService) ListLanguageModels(input *ListLanguageModelsInput) (*ListLanguageModelsOutput, error) { @@ -2534,8 +2634,11 @@ func (c *TranscribeService) ListMedicalTranscriptionJobsRequest(input *ListMedic // ListMedicalTranscriptionJobs API operation for Amazon Transcribe Service. // -// Lists medical transcription jobs with a specified status or substring that -// matches their names. +// Provides a list of medical transcription jobs that match the specified criteria. +// If no criteria are specified, all medical transcription jobs are returned. +// +// To get detailed information about a specific medical transcription job, use +// the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2546,18 +2649,18 @@ func (c *TranscribeService) ListMedicalTranscriptionJobsRequest(input *ListMedic // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobs func (c *TranscribeService) ListMedicalTranscriptionJobs(input *ListMedicalTranscriptionJobsInput) (*ListMedicalTranscriptionJobsOutput, error) { @@ -2683,9 +2786,11 @@ func (c *TranscribeService) ListMedicalVocabulariesRequest(input *ListMedicalVoc // ListMedicalVocabularies API operation for Amazon Transcribe Service. // -// Returns a list of vocabularies that match the specified criteria. If you -// don't enter a value in any of the request parameters, returns the entire -// list of vocabularies. +// Provides a list of custom medical vocabularies that match the specified criteria. +// If no criteria are specified, all custom medical vocabularies are returned. +// +// To get detailed information about a specific custom medical vocabulary, use +// the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2696,18 +2801,18 @@ func (c *TranscribeService) ListMedicalVocabulariesRequest(input *ListMedicalVoc // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabularies func (c *TranscribeService) ListMedicalVocabularies(input *ListMedicalVocabulariesInput) (*ListMedicalVocabulariesOutput, error) { @@ -2827,8 +2932,11 @@ func (c *TranscribeService) ListTagsForResourceRequest(input *ListTagsForResourc // ListTagsForResource API operation for Amazon Transcribe Service. // -// Lists all tags associated with a given transcription job, vocabulary, or -// resource. +// Lists all tags associated with the specified transcription job, vocabulary, +// model, or resource. +// +// To learn more about using tags with Amazon Transcribe, refer to Tagging resources +// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2839,22 +2947,22 @@ func (c *TranscribeService) ListTagsForResourceRequest(input *ListTagsForResourc // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTagsForResource func (c *TranscribeService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { @@ -2928,7 +3036,10 @@ func (c *TranscribeService) ListTranscriptionJobsRequest(input *ListTranscriptio // ListTranscriptionJobs API operation for Amazon Transcribe Service. // -// Lists transcription jobs with the specified status. +// Provides a list of transcription jobs that match the specified criteria. +// If no criteria are specified, all transcription jobs are returned. +// +// To get detailed information about a specific transcription job, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2939,18 +3050,18 @@ func (c *TranscribeService) ListTranscriptionJobsRequest(input *ListTranscriptio // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs func (c *TranscribeService) ListTranscriptionJobs(input *ListTranscriptionJobsInput) (*ListTranscriptionJobsOutput, error) { @@ -3076,8 +3187,10 @@ func (c *TranscribeService) ListVocabulariesRequest(input *ListVocabulariesInput // ListVocabularies API operation for Amazon Transcribe Service. // -// Returns a list of vocabularies that match the specified criteria. If no criteria -// are specified, returns the entire list of vocabularies. +// Provides a list of custom vocabularies that match the specified criteria. +// If no criteria are specified, all custom vocabularies are returned. +// +// To get detailed information about a specific custom vocabulary, use the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3088,18 +3201,18 @@ func (c *TranscribeService) ListVocabulariesRequest(input *ListVocabulariesInput // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularies func (c *TranscribeService) ListVocabularies(input *ListVocabulariesInput) (*ListVocabulariesOutput, error) { @@ -3225,7 +3338,11 @@ func (c *TranscribeService) ListVocabularyFiltersRequest(input *ListVocabularyFi // ListVocabularyFilters API operation for Amazon Transcribe Service. // -// Gets information about vocabulary filters. +// Provides a list of custom vocabulary filters that match the specified criteria. +// If no criteria are specified, all custom vocabularies are returned. +// +// To get detailed information about a specific custom vocabulary filter, use +// the operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3236,18 +3353,18 @@ func (c *TranscribeService) ListVocabularyFiltersRequest(input *ListVocabularyFi // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFilters func (c *TranscribeService) ListVocabularyFilters(input *ListVocabularyFiltersInput) (*ListVocabularyFiltersOutput, error) { @@ -3367,13 +3484,46 @@ func (c *TranscribeService) StartCallAnalyticsJobRequest(input *StartCallAnalyti // StartCallAnalyticsJob API operation for Amazon Transcribe Service. // -// Starts an asynchronous analytics job that not only transcribes the audio -// recording of a caller and agent, but also returns additional insights. These -// insights include how quickly or loudly the caller or agent was speaking. -// To retrieve additional insights with your analytics jobs, create categories. -// A category is a way to classify analytics jobs based on attributes, such -// as a customer's sentiment or a particular phrase being used during the call. -// For more information, see the operation. +// Transcribes the audio from a customer service call and applies any additional +// Request Parameters you choose to include in your request. +// +// In addition to many of the standard transcription features, Call Analytics +// provides you with call characteristics, call summarization, speaker sentiment, +// and optional redaction of your text transcript and your audio file. You can +// also apply custom categories to flag specified conditions. To learn more +// about these features and insights, refer to Analyzing call center audio with +// Call Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html). +// +// If you want to apply categories to your Call Analytics job, you must create +// them before submitting your job request. Categories cannot be retroactively +// applied to a job. To create a new category, use the operation. To learn more +// about Call Analytics categories, see Creating categories (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html). +// +// To make a StartCallAnalyticsJob request, you must first upload your media +// file into an Amazon S3 bucket; you can then specify the Amazon S3 location +// of the file using the Media parameter. +// +// You must include the following parameters in your StartCallAnalyticsJob request: +// +// * region: The Amazon Web Services Region where you are making your request. +// For a list of Amazon Web Services Regions supported with Amazon Transcribe, +// refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html). +// +// * CallAnalyticsJobName: A custom name you create for your transcription +// job that is unique within your Amazon Web Services account. +// +// * DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that +// has permissions to access the Amazon S3 bucket that contains your input +// files. +// +// * Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location +// of your media file. +// +// With Call Analytics, you can redact the audio contained in your media file +// by including RedactedMediaFileUri, instead of MediaFileUri, to specify the +// location of your input audio. If you choose to redact your audio, you can +// find your redacted media at the location specified in the RedactedMediaFileUri +// field of your response. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3384,21 +3534,22 @@ func (c *TranscribeService) StartCallAnalyticsJobRequest(input *StartCallAnalyti // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartCallAnalyticsJob func (c *TranscribeService) StartCallAnalyticsJob(input *StartCallAnalyticsJobInput) (*StartCallAnalyticsJobOutput, error) { @@ -3466,7 +3617,40 @@ func (c *TranscribeService) StartMedicalTranscriptionJobRequest(input *StartMedi // StartMedicalTranscriptionJob API operation for Amazon Transcribe Service. // -// Starts a batch job to transcribe medical speech to text. +// Transcribes the audio from a medical dictation or conversation and applies +// any additional Request Parameters you choose to include in your request. +// +// In addition to many of the standard transcription features, Amazon Transcribe +// Medical provides you with a robust medical vocabulary and, optionally, content +// identification, which adds flags to personal health information (PHI). To +// learn more about these features, refer to How Amazon Transcribe Medical works +// (https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html). +// +// To make a StartMedicalTranscriptionJob request, you must first upload your +// media file into an Amazon S3 bucket; you can then specify the S3 location +// of the file using the Media parameter. +// +// You must include the following parameters in your StartMedicalTranscriptionJob +// request: +// +// * region: The Amazon Web Services Region where you are making your request. +// For a list of Amazon Web Services Regions supported with Amazon Transcribe, +// refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html). +// +// * MedicalTranscriptionJobName: A custom name you create for your transcription +// job that is unique within your Amazon Web Services account. +// +// * Media (MediaFileUri): The Amazon S3 location of your media file. +// +// * LanguageCode: This must be en-US. +// +// * OutputBucketName: The Amazon S3 bucket where you want your transcript +// stored. If you want your output stored in a sub-folder of this bucket, +// you must also include OutputKey. +// +// * Specialty: This must be PRIMARYCARE. +// +// * Type: Choose whether your audio is a conversation or a dictation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3477,21 +3661,22 @@ func (c *TranscribeService) StartMedicalTranscriptionJobRequest(input *StartMedi // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJob func (c *TranscribeService) StartMedicalTranscriptionJob(input *StartMedicalTranscriptionJobInput) (*StartMedicalTranscriptionJobOutput, error) { @@ -3559,7 +3744,31 @@ func (c *TranscribeService) StartTranscriptionJobRequest(input *StartTranscripti // StartTranscriptionJob API operation for Amazon Transcribe Service. // -// Starts an asynchronous job to transcribe speech to text. +// Transcribes the audio from a media file and applies any additional Request +// Parameters you choose to include in your request. +// +// To make a StartTranscriptionJob request, you must first upload your media +// file into an Amazon S3 bucket; you can then specify the Amazon S3 location +// of the file using the Media parameter. +// +// You must include the following parameters in your StartTranscriptionJob request: +// +// * region: The Amazon Web Services Region where you are making your request. +// For a list of Amazon Web Services Regions supported with Amazon Transcribe, +// refer to Amazon Transcribe endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html). +// +// * TranscriptionJobName: A custom name you create for your transcription +// job that is unique within your Amazon Web Services account. +// +// * Media (MediaFileUri): The Amazon S3 location of your media file. +// +// * One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: +// If you know the language of your media file, specify it using the LanguageCode +// parameter; you can find all valid language codes in the Supported languages +// (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) +// table. If you don't know the languages spoken in your media, use either +// IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe +// identify the languages for you. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3570,21 +3779,22 @@ func (c *TranscribeService) StartTranscriptionJobRequest(input *StartTranscripti // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJob func (c *TranscribeService) StartTranscriptionJob(input *StartTranscriptionJobInput) (*StartTranscriptionJobOutput, error) { @@ -3653,7 +3863,11 @@ func (c *TranscribeService) TagResourceRequest(input *TagResourceInput) (req *re // TagResource API operation for Amazon Transcribe Service. // -// Tags an Amazon Transcribe resource with the given list of tags. +// Adds one or more custom tags, each in the form of a key:value pair, to the +// specified resource. +// +// To learn more about using tags with Amazon Transcribe, refer to Tagging resources +// (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3664,25 +3878,26 @@ func (c *TranscribeService) TagResourceRequest(input *TagResourceInput) (req *re // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TagResource func (c *TranscribeService) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { @@ -3751,7 +3966,10 @@ func (c *TranscribeService) UntagResourceRequest(input *UntagResourceInput) (req // UntagResource API operation for Amazon Transcribe Service. // -// Removes specified tags from a specified Amazon Transcribe resource. +// Removes the specified tags from the specified Amazon Transcribe resource. +// +// If you include UntagResource in your request, you must also include ResourceArn +// and TagKeys. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3762,25 +3980,26 @@ func (c *TranscribeService) UntagResourceRequest(input *UntagResourceInput) (req // // Returned Error Types: // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UntagResource func (c *TranscribeService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { @@ -3848,9 +4067,12 @@ func (c *TranscribeService) UpdateCallAnalyticsCategoryRequest(input *UpdateCall // UpdateCallAnalyticsCategory API operation for Amazon Transcribe Service. // -// Updates the call analytics category with new values. The UpdateCallAnalyticsCategory -// operation overwrites all of the existing information with the values that -// you provide in the request. +// Updates the specified Call Analytics category with new rules. Note that the +// UpdateCallAnalyticsCategory operation overwrites all existing rules contained +// in the specified category. You cannot append additional rules onto an existing +// category. +// +// To create a new category, see . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3861,25 +4083,26 @@ func (c *TranscribeService) UpdateCallAnalyticsCategoryRequest(input *UpdateCall // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategory func (c *TranscribeService) UpdateCallAnalyticsCategory(input *UpdateCallAnalyticsCategoryInput) (*UpdateCallAnalyticsCategoryOutput, error) { @@ -3947,10 +4170,9 @@ func (c *TranscribeService) UpdateMedicalVocabularyRequest(input *UpdateMedicalV // UpdateMedicalVocabulary API operation for Amazon Transcribe Service. // -// Updates a vocabulary with new values that you provide in a different text -// file from the one you used to create the vocabulary. The UpdateMedicalVocabulary -// operation overwrites all of the existing information with the values that -// you provide in the request. +// Updates an existing custom medical vocabulary with new values. This operation +// overwrites all existing information with your new values; you cannot append +// new terms onto an existing vocabulary. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3961,25 +4183,26 @@ func (c *TranscribeService) UpdateMedicalVocabularyRequest(input *UpdateMedicalV // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabulary func (c *TranscribeService) UpdateMedicalVocabulary(input *UpdateMedicalVocabularyInput) (*UpdateMedicalVocabularyOutput, error) { @@ -4047,9 +4270,9 @@ func (c *TranscribeService) UpdateVocabularyRequest(input *UpdateVocabularyInput // UpdateVocabulary API operation for Amazon Transcribe Service. // -// Updates an existing vocabulary with new values. The UpdateVocabulary operation -// overwrites all of the existing information with the values that you provide -// in the request. +// Updates an existing custom vocabulary with new values. This operation overwrites +// all existing information with your new values; you cannot append new terms +// onto an existing vocabulary. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4060,25 +4283,26 @@ func (c *TranscribeService) UpdateVocabularyRequest(input *UpdateVocabularyInput // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // * ConflictException -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabulary func (c *TranscribeService) UpdateVocabulary(input *UpdateVocabularyInput) (*UpdateVocabularyOutput, error) { @@ -4146,7 +4370,9 @@ func (c *TranscribeService) UpdateVocabularyFilterRequest(input *UpdateVocabular // UpdateVocabularyFilter API operation for Amazon Transcribe Service. // -// Updates a vocabulary filter with a new list of filtered words. +// Updates an existing custom vocabulary filter with a new list of words. The +// new list you provide overwrites all previous entries; you cannot append new +// terms onto an existing vocabulary filter. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4157,22 +4383,22 @@ func (c *TranscribeService) UpdateVocabularyFilterRequest(input *UpdateVocabular // // Returned Error Types: // * BadRequestException -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. // // * LimitExceededException -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. // // * InternalFailureException -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. // // * NotFoundException -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyFilter func (c *TranscribeService) UpdateVocabularyFilter(input *UpdateVocabularyFilterInput) (*UpdateVocabularyFilterOutput, error) { @@ -4196,42 +4422,41 @@ func (c *TranscribeService) UpdateVocabularyFilterWithContext(ctx aws.Context, i return out, req.Send() } -// A time range, set in seconds, between two points in the call. +// A time range, in milliseconds, between two points in your media file. +// +// You can use StartTime and EndTime to search a custom segment. For example, +// setting StartTime to 10000 and EndTime to 50000 only searches for your specified +// criteria in the audio contained between the 10,000 millisecond mark and the +// 50,000 millisecond mark of your media file. You must use StartTime and EndTime +// as a set; that is, if you include one, you must include both. +// +// You can use also First to search from the start of the audio until the time +// you specify, or Last to search from the time you specify until the end of +// the audio. For example, setting First to 50000 only searches for your specified +// criteria in the audio contained between the start of the media file to the +// 50,000 millisecond mark. You can use First and Last independently of each +// other. +// +// If you prefer to use percentage instead of milliseconds, see . type AbsoluteTimeRange struct { _ struct{} `type:"structure"` - // A value that indicates the end of the time range in milliseconds. To set - // absolute time range, you must specify a start time and an end time. For example, - // if you specify the following values: - // - // * StartTime - 10000 - // - // * Endtime - 50000 - // - // The time range is set between 10,000 milliseconds and 50,000 milliseconds - // into the call. + // The time, in milliseconds, when Amazon Transcribe stops searching for the + // specified criteria in your audio. If you include EndTime in your request, + // you must also include StartTime. EndTime *int64 `type:"long"` - // A time range from the beginning of the call to the value that you've specified. - // For example, if you specify 100000, the time range is set to the first 100,000 - // milliseconds of the call. + // The time, in milliseconds, from the start of your media file until the value + // you specify in which Amazon Transcribe searches for your specified criteria. First *int64 `type:"long"` - // A time range from the value that you've specified to the end of the call. - // For example, if you specify 100000, the time range is set to the last 100,000 - // milliseconds of the call. + // The time, in milliseconds, from the value you specify until the end of your + // media file in which Amazon Transcribe searches for your specified criteria. Last *int64 `type:"long"` - // A value that indicates the beginning of the time range in seconds. To set - // absolute time range, you must specify a start time and an end time. For example, - // if you specify the following values: - // - // * StartTime - 10000 - // - // * Endtime - 50000 - // - // The time range is set between 10,000 milliseconds and 50,000 milliseconds - // into the call. + // The time, in milliseconds, when Amazon Transcribe starts searching for the + // specified criteria in your audio. If you include StartTime in your request, + // you must also include EndTime. StartTime *int64 `type:"long"` } @@ -4277,10 +4502,9 @@ func (s *AbsoluteTimeRange) SetStartTime(v int64) *AbsoluteTimeRange { return s } -// Your request didn't pass one or more validation tests. For example, if the -// entity that you're trying to delete doesn't exist or if it is in a non-terminal -// state (for example, it's "in progress"). See the exception Message field -// for more information. +// Your request didn't pass one or more validation tests. This can occur when +// the entity you're trying to delete doesn't exist or if it's in a non-terminal +// state (such as IN PROGRESS). See the exception message field for more information. type BadRequestException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4344,98 +4568,138 @@ func (s *BadRequestException) RequestID() string { return s.RespMetadata.RequestID } -// Describes an asynchronous analytics job that was created with the StartAnalyticsJob -// operation. +// Provides detailed information about a Call Analytics job. +// +// To view the job's status, refer to CallAnalyticsJobStatus. If the status +// is COMPLETED, the job is finished. You can find your completed transcript +// at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason +// provides details on why your transcription job failed. +// +// If you enabled personally identifiable information (PII) redaction, the redacted +// transcript appears at the location specified in RedactedTranscriptFileUri. +// +// If you chose to redact the audio in your media file, you can find your redacted +// media file at the location specified in the RedactedMediaFileUri field of +// your response. type CallAnalyticsJob struct { _ struct{} `type:"structure"` - // The name of the call analytics job. + // The name of the Call Analytics job. Job names are case sensitive and must + // be unique within an Amazon Web Services account. CallAnalyticsJobName *string `min:"1" type:"string"` - // The status of the analytics job. + // Provides the status of the specified Call Analytics job. + // + // If the status is COMPLETED, the job is finished and you can find the results + // at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, + // if you requested transcript redaction). If the status is FAILED, FailureReason + // provides details on why your transcription job failed. CallAnalyticsJobStatus *string `type:"string" enum:"CallAnalyticsJobStatus"` - // Shows numeric values to indicate the channel assigned to the agent's audio - // and the channel assigned to the customer's audio. + // Allows you to specify which speaker is on which channel in your Call Analytics + // job request. For example, if your agent is the first participant to speak, + // you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole + // to AGENT (to indicate that it's the agent speaking). ChannelDefinitions []*ChannelDefinition `min:"2" type:"list"` - // A timestamp that shows when the analytics job was completed. + // The date and time the specified Call Analytics job finished processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started + // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time `type:"timestamp"` - // A timestamp that shows when the analytics job was created. + // The date and time the specified Call Analytics job request was made. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time `type:"timestamp"` - // The Amazon Resource Number (ARN) that you use to access the analytics job. - // ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id. + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role you specify + // doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. + // + // IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. + // For example: arn:aws:iam::111122223333:role/Admin. + // + // For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). DataAccessRoleArn *string `min:"20" type:"string"` - // If the AnalyticsJobStatus is FAILED, this field contains information about - // why the job failed. + // If CallAnalyticsJobStatus is FAILED, FailureReason contains information about + // why the Call Analytics job request failed. // - // The FailureReason field can contain one of the following values: + // The FailureReason field contains one of the following values: // - // * Unsupported media format: The media format specified in the MediaFormat - // field of the request isn't valid. See the description of the MediaFormat - // field for a list of valid values. + // * Unsupported media format. The media format specified in MediaFormat + // isn't valid. Refer to MediaFormat for a list of supported formats. // - // * The media format provided does not match the detected media format: - // The media format of the audio file doesn't match the format specified - // in the MediaFormat field in the request. Check the media format of your - // media file and make sure the two values match. + // * The media format provided does not match the detected media format. + // The media format specified in MediaFormat doesn't match the format of + // the input file. Check the media format of your media file and correct + // the specified value. // - // * Invalid sample rate for audio file: The sample rate specified in the - // MediaSampleRateHertz of the request isn't valid. The sample rate must - // be between 8,000 and 48,000 Hertz. + // * Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz + // isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. // - // * The sample rate provided does not match the detected sample rate: The - // sample rate in the audio file doesn't match the sample rate specified - // in the MediaSampleRateHertz field in the request. Check the sample rate - // of your media file and make sure that the two values match. + // * The sample rate provided does not match the detected sample rate. The + // sample rate specified in MediaSampleRateHertz doesn't match the sample + // rate detected in your input media file. Check the sample rate of your + // media file and correct the specified value. // - // * Invalid file size: file size too large: The size of your audio file - // is larger than what Amazon Transcribe Medical can process. For more information, - // see Guidelines and Quotas in the Amazon Transcribe Medical Guide. + // * Invalid file size: file size too large. The size of your media file + // is larger than what Amazon Transcribe can process. For more information, + // refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). // - // * Invalid number of channels: number of channels too large: Your audio - // contains more channels than Amazon Transcribe Medical is configured to - // process. To request additional channels, see Amazon Transcribe Medical - // Endpoints and Quotas in the Amazon Web Services General Reference (https://docs.aws.amazon.com/general/latest/gr/Welcome.html). + // * Invalid number of channels: number of channels too large. Your audio + // contains more channels than Amazon Transcribe is able to process. For + // more information, refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). FailureReason *string `type:"string"` - // A value between zero and one that Amazon Transcribe assigned to the language - // that it identified in the source audio. This value appears only when you - // don't provide a single language code. Larger values indicate that Amazon - // Transcribe has higher confidence in the language that it identified. + // The confidence score associated with the language identified in your media + // file. + // + // Confidence scores are values between 0 and 1; a larger value indicates a + // higher probability that the identified language correctly matches the language + // spoken in your media. IdentifiedLanguageScore *float64 `type:"float"` - // If you know the language spoken between the customer and the agent, specify - // a language code for this field. + // The language code used to create your Call Analytics job. For a list of supported + // languages and their associated language codes, refer to the Supported languages + // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. // - // If you don't know the language, you can leave this field blank, and Amazon - // Transcribe will use machine learning to automatically identify the language. - // To improve the accuracy of language identification, you can provide an array - // containing the possible language codes for the language spoken in your audio. - // Refer to Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) - // for additional information. + // If you don't know the language spoken in your media file, you can omit this + // field and let Amazon Transcribe automatically identify the language of your + // media. To improve the accuracy of language identification, you can include + // several language codes and Amazon Transcribe chooses the closest match for + // your transcription. LanguageCode *string `type:"string" enum:"LanguageCode"` - // Describes the input media file in a transcription request. + // Describes the Amazon S3 location of the media file you want to use in your + // request. Media *Media `type:"structure"` - // The format of the input audio file. Note: for call analytics jobs, only the - // following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM. + // The format of the input media file. MediaFormat *string `type:"string" enum:"MediaFormat"` - // The sample rate, in Hertz, of the input audio. + // The sample rate, in Hertz, of the audio track in your input media file. MediaSampleRateHertz *int64 `min:"8000" type:"integer"` - // Provides information about the settings used to run a transcription job. + // Allows additional optional settings in your request, including content redaction; + // allows you to apply custom language models, vocabulary filters, and custom + // vocabularies to your Call Analytics job. Settings *CallAnalyticsJobSettings `type:"structure"` - // A timestamp that shows when the analytics job started processing. + // The date and time the specified Call Analytics job began processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time `type:"timestamp"` - // Identifies the location of a transcription. + // Provides you with the Amazon S3 URI you can use to access your transcript. Transcript *Transcript `type:"structure"` } @@ -4547,46 +4811,82 @@ func (s *CallAnalyticsJob) SetTranscript(v *Transcript) *CallAnalyticsJob { return s } -// Provides optional settings for the CallAnalyticsJob operation. +// Provides additional optional settings for your request, including content +// redaction, automatic language identification; allows you to apply custom +// language models, vocabulary filters, and custom vocabularies. type CallAnalyticsJobSettings struct { _ struct{} `type:"structure"` - // Settings for content redaction within a transcription job. + // Allows you to redact or flag specified personally identifiable information + // (PII) in your transcript. If you use ContentRedaction, you must also include + // the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType. ContentRedaction *ContentRedaction `type:"structure"` - // The language identification settings associated with your call analytics - // job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName. + // If using automatic language identification (IdentifyLanguage) in your request + // and you want to apply a custom language model, a custom vocabulary, or a + // custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters + // (VocabularyName, LanguageModelName, and VocabularyFilterName). + // + // You can specify two or more language codes that represent the languages you + // think may be present in your media; including more than five is not recommended. + // Each language code you include can have an associated custom language model, + // custom vocabulary, and custom vocabulary filter. The languages you specify + // must match the languages of the specified custom language models, custom + // vocabularies, and custom vocabulary filters. + // + // To include language options using IdentifyLanguage without including a custom + // language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions + // instead of LanguageIdSettings. Including language options can improve the + // accuracy of automatic language identification. + // + // If you want to include a custom language model with your request but do not + // want to use automatic language identification, use instead the parameter + // with the LanguageModelName sub-parameter. + // + // If you want to include a custom vocabulary or a custom vocabulary filter + // (or both) with your request but do not want to use automatic language identification, + // use instead the parameter with the VocabularyName or VocabularyFilterName + // (or both) sub-parameter. LanguageIdSettings map[string]*LanguageIdSettings `min:"1" type:"map"` - // The structure used to describe a custom language model. + // The name of the custom language model you want to use when processing your + // Call Analytics job. Note that language model names are case sensitive. + // + // The language of the specified language model must match the language code + // you specify in your transcription request. If the languages don't match, + // the language model isn't applied. There are no errors or warnings associated + // with a language mismatch. LanguageModelName *string `min:"1" type:"string"` - // When you run a call analytics job, you can specify the language spoken in - // the audio, or you can have Amazon Transcribe identify the language for you. + // You can specify two or more language codes that represent the languages you + // think may be present in your media; including more than five is not recommended. + // If you're unsure what languages are present, do not include this parameter. + // + // Including language options can improve the accuracy of language identification. // - // To specify a language, specify an array with one language code. If you don't - // know the language, you can leave this field blank and Amazon Transcribe will - // use machine learning to identify the language for you. To improve the ability - // of Amazon Transcribe to correctly identify the language, you can provide - // an array of the languages that can be present in the audio. Refer to Supported + // For a list of languages supported with Call Analytics, refer to the Supported // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) - // for additional information. + // table. LanguageOptions []*string `min:"1" type:"list" enum:"LanguageCode"` - // Set to mask to remove filtered text from the transcript and replace it with - // three asterisks ("***") as placeholder text. Set to remove to remove filtered - // text from the transcript without using placeholder text. Set to tag to mark - // the word in the transcription output that matches the vocabulary filter. - // When you set the filter method to tag, the words matching your vocabulary - // filter are not masked or removed. + // Specify how you want your vocabulary filter applied to your transcript. + // + // To replace words with ***, choose mask. + // + // To delete words, choose remove. + // + // To flag words without changing them, choose tag. VocabularyFilterMethod *string `type:"string" enum:"VocabularyFilterMethod"` - // The name of the vocabulary filter to use when running a call analytics job. - // The filter that you specify must have the same language code as the analytics - // job. + // The name of the custom vocabulary filter you want to include in your Call + // Analytics transcription request. Vocabulary filter names are case sensitive. + // + // Note that if you include VocabularyFilterName in your request, you must also + // include VocabularyFilterMethod. VocabularyFilterName *string `min:"1" type:"string"` - // The name of a vocabulary to use when processing the call analytics job. + // The name of the custom vocabulary you want to include in your Call Analytics + // transcription request. Vocabulary names are case sensitive. VocabularyName *string `min:"1" type:"string"` } @@ -4690,29 +4990,48 @@ func (s *CallAnalyticsJobSettings) SetVocabularyName(v string) *CallAnalyticsJob return s } -// Provides summary information about a call analytics job. +// Provides detailed information about a specific Call Analytics job. type CallAnalyticsJobSummary struct { _ struct{} `type:"structure"` - // The name of the call analytics job. + // The name of the Call Analytics job. Job names are case sensitive and must + // be unique within an Amazon Web Services account. CallAnalyticsJobName *string `min:"1" type:"string"` - // The status of the call analytics job. + // Provides the status of your Call Analytics job. + // + // If the status is COMPLETED, the job is finished and you can find the results + // at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, + // if you requested transcript redaction). If the status is FAILED, FailureReason + // provides details on why your transcription job failed. CallAnalyticsJobStatus *string `type:"string" enum:"CallAnalyticsJobStatus"` - // A timestamp that shows when the job was completed. + // The date and time the specified Call Analytics job finished processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started + // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time `type:"timestamp"` - // A timestamp that shows when the call analytics job was created. + // The date and time the specified Call Analytics job request was made. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time `type:"timestamp"` - // If the CallAnalyticsJobStatus is FAILED, a description of the error. + // If CallAnalyticsJobStatus is FAILED, FailureReason contains information about + // why the Call Analytics job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The language of the transcript in the source audio file. + // The language code used to create your Call Analytics transcription. LanguageCode *string `type:"string" enum:"LanguageCode"` - // A timestamp that shows when the job began processing. + // The date and time your Call Analytics job began processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time `type:"timestamp"` } @@ -4776,22 +5095,30 @@ func (s *CallAnalyticsJobSummary) SetStartTime(v time.Time) *CallAnalyticsJobSum return s } -// An object that contains the rules and additional information about a call -// analytics category. +// Provides you with the properties of the Call Analytics category you specified +// in your request. This includes the list of rules that define the specified +// category. type CategoryProperties struct { _ struct{} `type:"structure"` - // The name of the call analytics category. + // The name of the Call Analytics category. Category names are case sensitive + // and must be unique within an Amazon Web Services account. CategoryName *string `min:"1" type:"string"` - // A timestamp that shows when the call analytics category was created. + // The date and time the specified Call Analytics category was created. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. CreateTime *time.Time `type:"timestamp"` - // A timestamp that shows when the call analytics category was most recently - // updated. + // The date and time the specified Call Analytics category was last updated. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022. LastUpdateTime *time.Time `type:"timestamp"` - // The rules used to create a call analytics category. + // The rules used to define a Call Analytics category. Each category can have + // between 1 and 20 rules. Rules []*Rule `min:"1" type:"list"` } @@ -4837,16 +5164,18 @@ func (s *CategoryProperties) SetRules(v []*Rule) *CategoryProperties { return s } -// For a call analytics job, an object that indicates the audio channel that -// belongs to the agent and the audio channel that belongs to the customer. +// Allows you to specify which speaker is on which channel. For example, if +// your agent is the first participant to speak, you would set ChannelId to +// 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate +// that it's the agent speaking). type ChannelDefinition struct { _ struct{} `type:"structure"` - // A value that indicates the audio channel. + // Specify the audio channel you want to define. ChannelId *int64 `type:"integer"` - // Indicates whether the person speaking on the audio channel is the agent or - // customer. + // Specify the speaker you want to define. Omitting this parameter is equivalent + // to specifying both participants. ParticipantRole *string `type:"string" enum:"ParticipantRole"` } @@ -4880,7 +5209,8 @@ func (s *ChannelDefinition) SetParticipantRole(v string) *ChannelDefinition { return s } -// There is already a resource with that name. +// A resource already exists with this name. Resource names must be unique within +// an Amazon Web Services account. type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4944,27 +5274,31 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } -// Settings for content redaction within a transcription job. +// Allows you to redact or flag specified personally identifiable information +// (PII) in your transcript. If you use ContentRedaction, you must also include +// the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType. type ContentRedaction struct { _ struct{} `type:"structure"` - // The types of personally identifiable information (PII) you want to redact - // in your transcript. + // Specify which types of personally identifiable information (PII) you want + // to redact in your transcript. You can include as many types as you'd like, + // or you can select ALL. PiiEntityTypes []*string `type:"list" enum:"PiiEntityType"` - // The output transcript file stored in either the default S3 bucket or in a - // bucket you specify. + // Specify if you want only a redacted transcript, or if you want a redacted + // and an unredacted transcript. // - // When you choose redacted Amazon Transcribe outputs only the redacted transcript. + // When you choose redacted Amazon Transcribe creates only a redacted transcript. // - // When you choose redacted_and_unredacted Amazon Transcribe outputs both the - // redacted and unredacted transcripts. + // When you choose redacted_and_unredacted Amazon Transcribe creates a redacted + // and an unredacted transcript (as two separate files). // // RedactionOutput is a required field RedactionOutput *string `type:"string" required:"true" enum:"RedactionOutput"` - // Request parameter that defines the entities to be redacted. The only accepted - // value is PII. + // Specify the category of information you want to redact; PII (personally identifiable + // information) is the only valid value. You can use PiiEntityTypes to choose + // which types of PII you want to redact. // // RedactionType is a required field RedactionType *string `type:"string" required:"true" enum:"RedactionType"` @@ -5025,17 +5359,21 @@ func (s *ContentRedaction) SetRedactionType(v string) *ContentRedaction { type CreateCallAnalyticsCategoryInput struct { _ struct{} `type:"structure"` - // A unique name, chosen by you, for your call analytics category. For example, - // sentiment-positive-last30seconds. + // A unique name, chosen by you, for your Call Analytics category. It's helpful + // to use a detailed naming system that will make sense to you in the future. + // For example, it's better to use sentiment-positive-last30seconds for a category + // over a generic name like test-category. + // + // Category names are case sensitive. // // CategoryName is a required field CategoryName *string `min:"1" type:"string" required:"true"` - // Rules make up a call analytics category. When creating a call analytics category, - // you must create between 1 and 20 rules for your category. For each rule, - // you specify a filter you want applied to the attributes of a call. For example, - // you can choose a sentiment filter that detects if a customer's sentiment - // was positive during the last 30 seconds of the call. + // Rules define a Call Analytics category. When creating a new Call Analytics + // category, you must create between 1 and 20 rules for that category. For each + // rule, you specify a filter you want applied to the attributes of a call. + // For example, you can choose a sentiment filter that detects if a customer's + // sentiment was positive during the last 30 seconds of the call. // // Rules is a required field Rules []*Rule `min:"1" type:"list" required:"true"` @@ -5106,12 +5444,8 @@ func (s *CreateCallAnalyticsCategoryInput) SetRules(v []*Rule) *CreateCallAnalyt type CreateCallAnalyticsCategoryOutput struct { _ struct{} `type:"structure"` - // If your audio matches one of your categories, this field contains data on - // that category and its associated rules. This parameter shows which category - // is flagged (CategoryName) along with metadata for the rules that match your - // audio. Metadata includes the rule filter (such as InterruptionFilter, NonTalkTimeFilter, - // SentimentFilter, and TranscriptFilter) and where in your audio (StartTime - // and EndTime) the rule has a match. + // Provides you with the properties of your new category, including its associated + // rules. CategoryProperties *CategoryProperties `type:"structure"` } @@ -5153,29 +5487,52 @@ type CreateLanguageModelInput struct { // BaseModelName is a required field BaseModelName *string `type:"string" required:"true" enum:"BaseModelName"` - // Contains your data access role ARN (Amazon Resource Name) and the Amazon - // S3 locations of your training (S3Uri) and tuning (TuningDataS3Uri) data. + // Contains the Amazon S3 location of the training data you want to use to create + // a new custom language model, and permissions to access this location. + // + // When using InputDataConfig, you must include these sub-parameters: S3Uri, + // which is the Amazon S3 location of your training data, and DataAccessRoleArn, + // which is the Amazon Resource Name (ARN) of the role that has permission to + // access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, + // which is the Amazon S3 location of your tuning data. If you specify different + // Amazon S3 locations for training and tuning data, the ARN you use must have + // permissions to access both locations. // // InputDataConfig is a required field InputDataConfig *InputDataConfig `type:"structure" required:"true"` - // The language of your custom language model; note that the language code you - // select must match the language of your training and tuning data. + // The language code that represents the language of your model. Each language + // model must contain terms in only one language, and the language you select + // for your model must match the language of your training and tuning data. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. Note that U.S. English (en-US) is the only language supported with + // Amazon Transcribe Medical. + // + // A custom language model can only be used to transcribe files in the same + // language as the model. For example, if you create a language model using + // US English (en-US), you can only apply this model to files that contain English + // audio. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"CLMLanguageCode"` - // The name of your new custom language model. + // A unique name, chosen by you, for your custom language model. // // This name is case sensitive, cannot contain spaces, and must be unique within - // an Amazon Web Services account. If you try to create a language model with - // the same name as a previous language model, you get a ConflictException error. + // an Amazon Web Services account. If you try to create a new language model + // with the same name as an existing language model, you get a ConflictException + // error. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` - // Optionally add tags, each in the form of a key:value pair, to your new language - // model. See also: . + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new custom language model at the time you create this new model. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` } @@ -5273,26 +5630,22 @@ func (s *CreateLanguageModelInput) SetTags(v []*Tag) *CreateLanguageModelInput { type CreateLanguageModelOutput struct { _ struct{} `type:"structure"` - // The Amazon Transcribe standard language model, or base model, you used when - // creating your custom language model. - // - // If your audio has a sample rate of 16,000 Hz or greater, this value should - // be WideBand. If your audio has a sample rate of less than 16,000 Hz, this - // value should be NarrowBand. + // The Amazon Transcribe standard language model, or base model, you specified + // when creating your custom language model. BaseModelName *string `type:"string" enum:"BaseModelName"` // Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 - // locations your provided for your training (S3Uri) and tuning (TuningDataS3Uri) + // locations you provided for your training (S3Uri) and tuning (TuningDataS3Uri) // data. InputDataConfig *InputDataConfig `type:"structure"` // The language code you selected for your custom language model. LanguageCode *string `type:"string" enum:"CLMLanguageCode"` - // The unique name you chose for your custom language model. + // The name of your custom language model. ModelName *string `min:"1" type:"string"` - // The status of your custom language model. When the status shows as COMPLETED, + // The status of your custom language model. When the status displays as COMPLETED, // your model is ready to use. ModelStatus *string `type:"string" enum:"ModelStatus"` } @@ -5349,35 +5702,34 @@ type CreateMedicalVocabularyInput struct { _ struct{} `type:"structure"` // The language code that represents the language of the entries in your custom - // vocabulary. Note that U.S. English (en-US) is the only language supported - // with Amazon Transcribe Medical. + // vocabulary. US English (en-US) is the only language supported with Amazon + // Transcribe Medical. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // Adds one or more tags, each in the form of a key:value pair, to a new medical - // vocabulary at the time you create the new vocabulary. + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new medical vocabulary at the time you create this new vocabulary. // // To learn more about using tags with Amazon Transcribe, refer to Tagging resources // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` - // The Amazon S3 location (URI) of the text file that contains your custom vocabulary. - // The URI must be in the same Amazon Web Services Region as the resource that - // you're calling. + // The Amazon S3 location (URI) of the text file that contains your custom medical + // vocabulary. The URI must be in the same Amazon Web Services Region as the + // resource you're calling. // - // Here's an example URI path: - // - // https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt // // VocabularyFileUri is a required field VocabularyFileUri *string `min:"1" type:"string" required:"true"` - // The name of your new vocabulary. + // A unique name, chosen by you, for your new custom medical vocabulary. // // This name is case sensitive, cannot contain spaces, and must be unique within - // an Amazon Web Services account. If you try to create a vocabulary with the - // same name as a previous vocabulary, you get a ConflictException error. + // an Amazon Web Services account. If you try to create a new medical vocabulary + // with the same name as an existing medical vocabulary, you get a ConflictException + // error. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -5466,18 +5818,21 @@ func (s *CreateMedicalVocabularyInput) SetVocabularyName(v string) *CreateMedica type CreateMedicalVocabularyOutput struct { _ struct{} `type:"structure"` - // If the VocabularyState field is FAILED, FailureReason contains information - // about why the job failed. + // If VocabularyState is FAILED, FailureReason contains information about why + // the medical transcription job request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The language code you selected for your medical vocabulary. Note that U.S. - // English (en-US) is the only language supported with Amazon Transcribe Medical. + // The language code you selected for your medical vocabulary. US English (en-US) + // is the only language supported with Amazon Transcribe Medical. LanguageCode *string `type:"string" enum:"LanguageCode"` // The date and time you created your custom medical vocabulary. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name you chose for your vocabulary. + // The name you chose for your custom medical vocabulary. VocabularyName *string `min:"1" type:"string"` // The processing state of your custom medical vocabulary. If the state is READY, @@ -5536,44 +5891,60 @@ func (s *CreateMedicalVocabularyOutput) SetVocabularyState(v string) *CreateMedi type CreateVocabularyFilterInput struct { _ struct{} `type:"structure"` - // The language code of the words in the vocabulary filter. All words in the - // filter must be in the same language. The vocabulary filter can only be used - // with transcription jobs in the specified language. + // The language code that represents the language of the entries in your vocabulary + // filter. Each vocabulary filter must contain terms in only one language. + // + // A vocabulary filter can only be used to transcribe files in the same language + // as the filter. For example, if you create a vocabulary filter using US English + // (en-US), you can only apply this filter to files that contain English audio. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // Adds one or more tags, each in the form of a key:value pair, to a new vocabulary - // filter at the time you create this new vocabulary filter. + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new custom vocabulary filter at the time you create this new filter. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` - // The Amazon S3 location of a text file used as input to create the vocabulary - // filter. Only use characters from the character set defined for custom vocabularies. - // For a list of character sets, see Character Sets for Custom Vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html). + // The Amazon S3 location of the text file that contains your custom vocabulary + // filter terms. The URI must be located in the same Amazon Web Services Region + // as the resource you're calling. // - // Your vocabulary filter file must be less than 50 KB in size. + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt // // Note that if you include VocabularyFilterFileUri in your request, you cannot // use Words; you must choose one or the other. VocabularyFilterFileUri *string `min:"1" type:"string"` - // The name of your new vocabulary filter. + // A unique name, chosen by you, for your new custom vocabulary filter. // // This name is case sensitive, cannot contain spaces, and must be unique within - // an Amazon Web Services account. If you try to create a vocabulary filter - // with the same name as a previous vocabulary filter, you get a ConflictException + // an Amazon Web Services account. If you try to create a new vocabulary filter + // with the same name as an existing vocabulary filter, you get a ConflictException // error. // // VocabularyFilterName is a required field VocabularyFilterName *string `min:"1" type:"string" required:"true"` - // The words you want in your vocabulary filter. Only use characters specified - // in the Character sets (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) - // for the language you're transcribing. + // Use this parameter if you want to create your vocabulary filter by including + // all desired terms, as comma-separated values, within your request. The other + // option for creating your vocabulary filter is to save your entries in a text + // file and upload them to an Amazon S3 bucket, then specify the location of + // your file using the VocabularyFilterFileUri parameter. // // Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; // you must choose one or the other. + // + // Each language has a character set that contains all allowed characters for + // that specific language. If you use unsupported characters, your vocabulary + // filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) + // to get the character set for your language. Words []*string `min:"1" type:"list"` } @@ -5666,13 +6037,16 @@ func (s *CreateVocabularyFilterInput) SetWords(v []*string) *CreateVocabularyFil type CreateVocabularyFilterOutput struct { _ struct{} `type:"structure"` - // The language code associated with your vocabulary filter. + // The language code you selected for your vocabulary filter. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time the vocabulary filter was modified. + // The date and time you created your vocabulary filter. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary filter. + // The name you chose for your custom vocabulary filter. VocabularyFilterName *string `min:"1" type:"string"` } @@ -5716,39 +6090,57 @@ type CreateVocabularyInput struct { _ struct{} `type:"structure"` // The language code that represents the language of the entries in your custom - // vocabulary. Each vocabulary must contain terms in only one language. For - // a list of languages and their corresponding language codes, see Supported - // languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html). + // vocabulary. Each vocabulary must contain terms in only one language. + // + // A custom vocabulary can only be used to transcribe files in the same language + // as the vocabulary. For example, if you create a vocabulary using US English + // (en-US), you can only apply this vocabulary to files that contain English + // audio. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // Use this flag to include a list of terms within your request. + // Use this parameter if you want to create your vocabulary by including all + // desired terms, as comma-separated values, within your request. The other + // option for creating your vocabulary is to save your entries in a text file + // and upload them to an Amazon S3 bucket, then specify the location of your + // file using the VocabularyFileUri parameter. // // Note that if you include Phrases in your request, you cannot use VocabularyFileUri; // you must choose one or the other. + // + // Each language has a character set that contains all allowed characters for + // that specific language. If you use unsupported characters, your vocabulary + // filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) + // to get the character set for your language. Phrases []*string `type:"list"` - // Adds one or more tags, each in the form of a key:value pair, to a new custom - // vocabulary at the time you create this new vocabulary. + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new custom vocabulary at the time you create this new vocabulary. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` - // The S3 location of the text file that contains your custom vocabulary. The - // URI must be located in the same region as the API endpoint you're calling. - // - // Here's an example URI path: + // The Amazon S3 location of the text file that contains your custom vocabulary. + // The URI must be located in the same Amazon Web Services Region as the resource + // you're calling. // - // https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt // // Note that if you include VocabularyFileUri in your request, you cannot use // the Phrases flag; you must choose one or the other. VocabularyFileUri *string `min:"1" type:"string"` - // The name of your new vocabulary. + // A unique name, chosen by you, for your new custom vocabulary. // // This name is case sensitive, cannot contain spaces, and must be unique within - // an Amazon Web Services account. If you try to create a vocabulary with the - // same name as a previous vocabulary, you get a ConflictException error. + // an Amazon Web Services account. If you try to create a new vocabulary with + // the same name as an existing vocabulary, you get a ConflictException error. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -5840,21 +6232,24 @@ func (s *CreateVocabularyInput) SetVocabularyName(v string) *CreateVocabularyInp type CreateVocabularyOutput struct { _ struct{} `type:"structure"` - // If the VocabularyState field is FAILED, FailureReason contains information - // about why the job failed. + // If VocabularyState is FAILED, FailureReason contains information about why + // the vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The language code you selected for your vocabulary. + // The language code you selected for your custom vocabulary. LanguageCode *string `type:"string" enum:"LanguageCode"` // The date and time you created your custom vocabulary. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name you chose for your vocabulary. + // The name you chose for your custom vocabulary. VocabularyName *string `min:"1" type:"string"` - // The processing state of your vocabulary. If the state is READY, you can use - // the vocabulary in a StartTranscriptionJob request. + // The processing state of your custom vocabulary. If the state is READY, you + // can use the vocabulary in a StartTranscriptionJob request. VocabularyState *string `type:"string" enum:"VocabularyState"` } @@ -5909,8 +6304,8 @@ func (s *CreateVocabularyOutput) SetVocabularyState(v string) *CreateVocabularyO type DeleteCallAnalyticsCategoryInput struct { _ struct{} `type:"structure"` - // The name of the call analytics category you want to delete. Category names - // are case-sensitive. + // The name of the Call Analytics category you want to delete. Category names + // are case sensitive. // // CategoryName is a required field CategoryName *string `min:"1" type:"string" required:"true"` @@ -5981,7 +6376,8 @@ func (s DeleteCallAnalyticsCategoryOutput) GoString() string { type DeleteCallAnalyticsJobInput struct { _ struct{} `type:"structure"` - // The name of the call analytics job you want to delete. Job names are case-sensitive. + // The name of the Call Analytics job you want to delete. Job names are case + // sensitive. // // CallAnalyticsJobName is a required field CallAnalyticsJobName *string `min:"1" type:"string" required:"true"` @@ -6052,7 +6448,8 @@ func (s DeleteCallAnalyticsJobOutput) GoString() string { type DeleteLanguageModelInput struct { _ struct{} `type:"structure"` - // The name of the model you want to delete. Model names are case-sensitive. + // The name of the custom language model you want to delete. Model names are + // case sensitive. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` @@ -6124,7 +6521,7 @@ type DeleteMedicalTranscriptionJobInput struct { _ struct{} `type:"structure"` // The name of the medical transcription job you want to delete. Job names are - // case-sensitive. + // case sensitive. // // MedicalTranscriptionJobName is a required field MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"` @@ -6195,8 +6592,8 @@ func (s DeleteMedicalTranscriptionJobOutput) GoString() string { type DeleteMedicalVocabularyInput struct { _ struct{} `type:"structure"` - // The name of the vocabulary that you want to delete. Vocabulary names are - // case-sensitive. + // The name of the custom medical vocabulary you want to delete. Vocabulary + // names are case sensitive. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -6267,7 +6664,8 @@ func (s DeleteMedicalVocabularyOutput) GoString() string { type DeleteTranscriptionJobInput struct { _ struct{} `type:"structure"` - // The name of the transcription job you want to delete. Job names are case-sensitive. + // The name of the transcription job you want to delete. Job names are case + // sensitive. // // TranscriptionJobName is a required field TranscriptionJobName *string `min:"1" type:"string" required:"true"` @@ -6338,8 +6736,8 @@ func (s DeleteTranscriptionJobOutput) GoString() string { type DeleteVocabularyFilterInput struct { _ struct{} `type:"structure"` - // The name of the vocabulary filter you want to delete. Vocabulary filter names - // are case-sensitive. + // The name of the custom vocabulary filter you want to delete. Vocabulary filter + // names are case sensitive. // // VocabularyFilterName is a required field VocabularyFilterName *string `min:"1" type:"string" required:"true"` @@ -6410,7 +6808,8 @@ func (s DeleteVocabularyFilterOutput) GoString() string { type DeleteVocabularyInput struct { _ struct{} `type:"structure"` - // The name of the vocabulary you want to delete. Vocabulary names are case-sensitive. + // The name of the custom vocabulary you want to delete. Vocabulary names are + // case sensitive. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -6481,8 +6880,8 @@ func (s DeleteVocabularyOutput) GoString() string { type DescribeLanguageModelInput struct { _ struct{} `type:"structure"` - // The name of the custom language model you want described. Model names are - // case-sensitive. + // The name of the custom language model you want information about. Model names + // are case sensitive. // // ModelName is a required field ModelName *string `min:"1" type:"string" required:"true"` @@ -6531,7 +6930,16 @@ func (s *DescribeLanguageModelInput) SetModelName(v string) *DescribeLanguageMod type DescribeLanguageModelOutput struct { _ struct{} `type:"structure"` - // The name of the custom language model you requested more information about. + // Provides information about the specified custom language model. + // + // This parameter also shows if the base language model you used to create your + // custom language model has been updated. If Amazon Transcribe has updated + // the base model, you can create a new custom language model using the updated + // base model. + // + // If you tried to create a new custom language model and the request wasn't + // successful, you can use this DescribeLanguageModel to help identify the reason + // for this failure. LanguageModel *LanguageModel `type:"structure"` } @@ -6562,8 +6970,8 @@ func (s *DescribeLanguageModelOutput) SetLanguageModel(v *LanguageModel) *Descri type GetCallAnalyticsCategoryInput struct { _ struct{} `type:"structure"` - // The name of the category you want information about. Category names are case - // sensitive. + // The name of the Call Analytics category you want information about. Category + // names are case sensitive. // // CategoryName is a required field CategoryName *string `min:"1" type:"string" required:"true"` @@ -6612,8 +7020,8 @@ func (s *GetCallAnalyticsCategoryInput) SetCategoryName(v string) *GetCallAnalyt type GetCallAnalyticsCategoryOutput struct { _ struct{} `type:"structure"` - // Provides you with the rules associated with the category you specified in - // your GetCallAnalyticsCategory request. + // Provides you with the properties of the Call Analytics category you specified + // in your GetCallAnalyticsCategory request. CategoryProperties *CategoryProperties `type:"structure"` } @@ -6644,8 +7052,8 @@ func (s *GetCallAnalyticsCategoryOutput) SetCategoryProperties(v *CategoryProper type GetCallAnalyticsJobInput struct { _ struct{} `type:"structure"` - // The name of the analytics job you want information about. This value is case - // sensitive. + // The name of the Call Analytics job you want information about. Job names + // are case sensitive. // // CallAnalyticsJobName is a required field CallAnalyticsJobName *string `min:"1" type:"string" required:"true"` @@ -6694,11 +7102,8 @@ func (s *GetCallAnalyticsJobInput) SetCallAnalyticsJobName(v string) *GetCallAna type GetCallAnalyticsJobOutput struct { _ struct{} `type:"structure"` - // An object that contains detailed information about your call analytics job. - // Returned fields include: CallAnalyticsJobName, CallAnalyticsJobStatus, ChannelDefinitions, - // CompletionTime, CreationTime, DataAccessRoleArn, FailureReason, IdentifiedLanguageScore, - // LanguageCode, Media, MediaFormat, MediaSampleRateHertz, Settings, StartTime, - // and Transcript. + // Provides detailed information about the specified Call Analytics job, including + // job status and, if applicable, failure reason. CallAnalyticsJob *CallAnalyticsJob `type:"structure"` } @@ -6729,8 +7134,8 @@ func (s *GetCallAnalyticsJobOutput) SetCallAnalyticsJob(v *CallAnalyticsJob) *Ge type GetMedicalTranscriptionJobInput struct { _ struct{} `type:"structure"` - // The name of the medical transcription job you want information about. This - // value is case sensitive. + // The name of the medical transcription job you want information about. Job + // names are case sensitive. // // MedicalTranscriptionJobName is a required field MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"` @@ -6779,11 +7184,8 @@ func (s *GetMedicalTranscriptionJobInput) SetMedicalTranscriptionJobName(v strin type GetMedicalTranscriptionJobOutput struct { _ struct{} `type:"structure"` - // An object that contains detailed information about your medical transcription - // job. Returned fields include: CompletionTime, ContentIdentificationType, - // CreationTime, FailureReason, LanguageCode, Media, MediaFormat, MediaSampleRateHertz, - // MedicalTranscriptionJobName, Settings, Specialty, StartTime, Tags, Transcript, - // TranscriptionJobStatus, and Type. + // Provides detailed information about the specified medical transcription job, + // including job status and, if applicable, failure reason. MedicalTranscriptionJob *MedicalTranscriptionJob `type:"structure"` } @@ -6814,8 +7216,8 @@ func (s *GetMedicalTranscriptionJobOutput) SetMedicalTranscriptionJob(v *Medical type GetMedicalVocabularyInput struct { _ struct{} `type:"structure"` - // The name of the medical vocabulary you want information about. This value - // is case sensitive. + // The name of the custom medical vocabulary you want information about. Vocabulary + // names are case sensitive. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -6864,29 +7266,29 @@ func (s *GetMedicalVocabularyInput) SetVocabularyName(v string) *GetMedicalVocab type GetMedicalVocabularyOutput struct { _ struct{} `type:"structure"` - // The S3 location where the vocabulary is stored; use this URI to view or download - // the vocabulary. + // The S3 location where the specified medical vocabulary is stored; use this + // URI to view or download the vocabulary. DownloadUri *string `min:"1" type:"string"` - // If your request returns a VocabularyState that is FAILED, the FailureReason - // field contains information about why the request failed. - // - // For more information, refer to the Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html) - // section. + // If VocabularyState is FAILED, FailureReason contains information about why + // the medical vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The valid language code for your vocabulary entries. + // The language code you selected for your medical vocabulary. US English (en-US) + // is the only language supported with Amazon Transcribe Medical. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary was last modified with a text file - // different from the one that was previously used. + // The date and time the specified custom medical vocabulary was last modified. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary returned by Amazon Transcribe Medical. + // The name of the custom medical vocabulary you requested information about. VocabularyName *string `min:"1" type:"string"` - // The processing state of the vocabulary. If the VocabularyState is READY then - // you can use it in the StartMedicalTranscriptionJob operation. + // The processing state of your custom medical vocabulary. If the state is READY, + // you can use the vocabulary in a StartMedicalTranscriptionJob request. VocabularyState *string `type:"string" enum:"VocabularyState"` } @@ -6947,7 +7349,8 @@ func (s *GetMedicalVocabularyOutput) SetVocabularyState(v string) *GetMedicalVoc type GetTranscriptionJobInput struct { _ struct{} `type:"structure"` - // The name of the job. + // The name of the transcription job you want information about. Job names are + // case sensitive. // // TranscriptionJobName is a required field TranscriptionJobName *string `min:"1" type:"string" required:"true"` @@ -6996,7 +7399,8 @@ func (s *GetTranscriptionJobInput) SetTranscriptionJobName(v string) *GetTranscr type GetTranscriptionJobOutput struct { _ struct{} `type:"structure"` - // An object that contains the results of the transcription job. + // Provides detailed information about the specified transcription job, including + // job status and, if applicable, failure reason. TranscriptionJob *TranscriptionJob `type:"structure"` } @@ -7027,7 +7431,8 @@ func (s *GetTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) *Ge type GetVocabularyFilterInput struct { _ struct{} `type:"structure"` - // The name of the vocabulary filter for which to return information. + // The name of the custom vocabulary filter you want information about. Vocabulary + // filter names are case sensitive. // // VocabularyFilterName is a required field VocabularyFilterName *string `min:"1" type:"string" required:"true"` @@ -7076,17 +7481,20 @@ func (s *GetVocabularyFilterInput) SetVocabularyFilterName(v string) *GetVocabul type GetVocabularyFilterOutput struct { _ struct{} `type:"structure"` - // The URI of the list of words in the vocabulary filter. You can use this URI - // to get the list of words. + // The Amazon S3 location where the vocabulary filter is stored; use this URI + // to view or download the vocabulary filter. DownloadUri *string `min:"1" type:"string"` - // The language code of the words in the vocabulary filter. + // The language code you selected for your vocabulary filter. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the contents of the vocabulary filter were updated. + // The date and time the specified vocabulary filter was last modified. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary filter. + // The name of the custom vocabulary filter you requested information about. VocabularyFilterName *string `min:"1" type:"string"` } @@ -7135,8 +7543,8 @@ func (s *GetVocabularyFilterOutput) SetVocabularyFilterName(v string) *GetVocabu type GetVocabularyInput struct { _ struct{} `type:"structure"` - // The name of the vocabulary to return information about. The name is case - // sensitive. + // The name of the custom vocabulary you want information about. Vocabulary + // names are case sensitive. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -7185,24 +7593,28 @@ func (s *GetVocabularyInput) SetVocabularyName(v string) *GetVocabularyInput { type GetVocabularyOutput struct { _ struct{} `type:"structure"` - // The S3 location where the vocabulary is stored. Use this URI to get the contents - // of the vocabulary. The URI is available for a limited time. + // The S3 location where the vocabulary is stored; use this URI to view or download + // the vocabulary. DownloadUri *string `min:"1" type:"string"` - // If the VocabularyState field is FAILED, this field contains information about - // why the job failed. + // If VocabularyState is FAILED, FailureReason contains information about why + // the vocabulary request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The language code of the vocabulary entries. + // The language code you selected for your custom vocabulary. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary was last modified. + // The date and time the specified vocabulary was last modified. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary to return. + // The name of the custom vocabulary you requested information about. VocabularyName *string `min:"1" type:"string"` - // The processing state of the vocabulary. + // The processing state of your custom vocabulary. If the state is READY, you + // can use the vocabulary in a StartTranscriptionJob request. VocabularyState *string `type:"string" enum:"VocabularyState"` } @@ -7260,26 +7672,39 @@ func (s *GetVocabularyOutput) SetVocabularyState(v string) *GetVocabularyOutput return s } -// The object that contains the Amazon S3 object location and access role required -// to train and tune your custom language model. +// Contains the Amazon S3 location of the training data you want to use to create +// a new custom language model, and permissions to access this location. +// +// When using InputDataConfig, you must include these sub-parameters: S3Uri +// and DataAccessRoleArn. You can optionally include TuningDataS3Uri. type InputDataConfig struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that uniquely identifies the permissions you've - // given Amazon Transcribe to access your Amazon S3 buckets containing your - // media files or text data. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id. + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role you specify + // doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. + // + // IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. + // For example: arn:aws:iam::111122223333:role/Admin. + // + // For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). // // DataAccessRoleArn is a required field DataAccessRoleArn *string `min:"20" type:"string" required:"true"` - // The Amazon S3 prefix you specify to access the plain text files that you - // use to train your custom language model. + // The Amazon S3 location (URI) of the text files you want to use to train your + // custom language model. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/ // // S3Uri is a required field S3Uri *string `min:"1" type:"string" required:"true"` - // The Amazon S3 prefix you specify to access the plain text files that you - // use to tune your custom language model. + // The Amazon S3 location (URI) of the text files you want to use to tune your + // custom language model. + // + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/ TuningDataS3Uri *string `min:"1" type:"string"` } @@ -7344,8 +7769,8 @@ func (s *InputDataConfig) SetTuningDataS3Uri(v string) *InputDataConfig { return s } -// There was an internal error. Check the error message and try your request -// again. +// There was an internal error. Check the error message, correct the issue, +// and try your request again. type InternalFailureException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7409,32 +7834,42 @@ func (s *InternalFailureException) RequestID() string { return s.RespMetadata.RequestID } -// An object that enables you to configure your category to be applied to call -// analytics jobs where either the customer or agent was interrupted. +// Flag the presence or absence of interruptions in your Call Analytics transcription +// output. +// +// Rules using InterruptionFilter are designed to match: +// +// * Instances where an agent interrupts a customer +// +// * Instances where a customer interrupts an agent +// +// * Either participant interrupting the other +// +// * A lack of interruptions +// +// See Rule criteria (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules) +// for usage examples. type InterruptionFilter struct { _ struct{} `type:"structure"` - // An object you can use to specify a time range (in milliseconds) for when - // you'd want to find the interruption. For example, you could search for an - // interruption between the 30,000 millisecond mark and the 45,000 millisecond - // mark. You could also specify the time period as the first 15,000 milliseconds - // or the last 15,000 milliseconds. + // Allows you to specify a time range (in milliseconds) in your audio, during + // which you want to search for an interruption. See for more detail. AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"` - // Set to TRUE to look for a time period where there was no interruption. + // Set to TRUE to flag speech that does not contain interruptions. Set to FALSE + // to flag speech that contains interruptions. Negate *bool `type:"boolean"` - // Indicates whether the caller or customer was interrupting. + // Specify the interrupter you want to flag. Omitting this parameter is equivalent + // to specifying both participants. ParticipantRole *string `type:"string" enum:"ParticipantRole"` - // An object that allows percentages to specify the proportion of the call where - // there was a interruption. For example, you can specify the first half of - // the call. You can also specify the period of time between halfway through - // to three-quarters of the way through the call. Because the length of conversation - // can vary between calls, you can apply relative time ranges across all calls. + // Allows you to specify a time range (in percentage) in your media file, during + // which you want to search for an interruption. See for more detail. RelativeTimeRange *RelativeTimeRange `type:"structure"` - // The duration of the interruption. + // Specify the duration of the interruptions in milliseconds. For example, you + // can flag speech that contains more than 10000 milliseconds of interruptions. Threshold *int64 `type:"long"` } @@ -7486,30 +7921,39 @@ func (s *InterruptionFilter) SetThreshold(v int64) *InterruptionFilter { return s } -// Provides information about when a transcription job should be executed. +// Allows you to control how your transcription job is processed. Currently, +// the only JobExecutionSettings modification you can choose is enabling job +// queueing using the AllowDeferredExecution sub-parameter. +// +// If you include JobExecutionSettings in your request, you must also include +// the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. type JobExecutionSettings struct { _ struct{} `type:"structure"` - // Indicates whether a job should be queued by Amazon Transcribe when the concurrent - // execution limit is exceeded. When the AllowDeferredExecution field is true, - // jobs are queued and executed when the number of executing jobs falls below - // the concurrent execution limit. If the field is false, Amazon Transcribe - // returns a LimitExceededException exception. + // Allows you to enable job queuing when your concurrent request limit is exceeded. + // When AllowDeferredExecution is set to true, transcription job requests are + // placed in a queue until the number of jobs falls below the concurrent request + // limit. If AllowDeferredExecution is set to false and the number of transcription + // job requests exceed the concurrent request limit, you get a LimitExceededException + // error. // - // Note that job queuing is enabled by default for call analytics jobs. + // Note that job queuing is enabled by default for Call Analytics jobs. // - // If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn - // field. + // If you include AllowDeferredExecution in your request, you must also include + // DataAccessRoleArn. AllowDeferredExecution *bool `type:"boolean"` - // The Amazon Resource Name (ARN), in the form arn:partition:service:region:account-id:resource-type/resource-id, - // of a role that has access to the S3 bucket that contains the input files. - // Amazon Transcribe assumes this role to read queued media files. If you have - // specified an output S3 bucket for the transcription results, this role should - // have access to the output bucket as well. + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role you specify + // doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. + // + // IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. + // For example: arn:aws:iam::111122223333:role/Admin. For more information, + // see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). // - // If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn - // field. + // Note that if you include DataAccessRoleArn in your request, you must also + // include AllowDeferredExecution. DataAccessRoleArn *string `min:"20" type:"string"` } @@ -7556,24 +8000,107 @@ func (s *JobExecutionSettings) SetDataAccessRoleArn(v string) *JobExecutionSetti return s } -// Language-specific settings that can be specified when language identification -// is enabled. +// Provides information on the speech contained in a discreet utterance when +// multi-language identification is enabled in your request. This utterance +// represents a block of speech consisting of one language, preceded or followed +// by a block of speech in a different language. +type LanguageCodeItem struct { + _ struct{} `type:"structure"` + + // Provides the total time, in seconds, each identified language is spoken in + // your media. + DurationInSeconds *float64 `type:"float"` + + // Provides the language code for each language identified in your media. + LanguageCode *string `type:"string" enum:"LanguageCode"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LanguageCodeItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LanguageCodeItem) GoString() string { + return s.String() +} + +// SetDurationInSeconds sets the DurationInSeconds field's value. +func (s *LanguageCodeItem) SetDurationInSeconds(v float64) *LanguageCodeItem { + s.DurationInSeconds = &v + return s +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *LanguageCodeItem) SetLanguageCode(v string) *LanguageCodeItem { + s.LanguageCode = &v + return s +} + +// If using automatic language identification (IdentifyLanguage) in your request +// and you want to apply a custom language model, a custom vocabulary, or a +// custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters +// (VocabularyName, LanguageModelName, and VocabularyFilterName). +// +// You can specify two or more language codes that represent the languages you +// think may be present in your media; including more than five is not recommended. +// Each language code you include can have an associated custom language model, +// custom vocabulary, and custom vocabulary filter. The languages you specify +// must match the languages of the specified custom language models, custom +// vocabularies, and custom vocabulary filters. +// +// To include language options using IdentifyLanguage without including a custom +// language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions +// instead of LanguageIdSettings. Including language options can improve the +// accuracy of automatic language identification. +// +// If you want to include a custom language model with your request but do not +// want to use automatic language identification, use instead the parameter +// with the LanguageModelName sub-parameter. +// +// If you want to include a custom vocabulary or a custom vocabulary filter +// (or both) with your request but do not want to use automatic language identification, +// use instead the parameter with the VocabularyName or VocabularyFilterName +// (or both) sub-parameter. type LanguageIdSettings struct { _ struct{} `type:"structure"` - // The name of the language model you want to use when transcribing your audio. - // The model you specify must have the same language codes as the transcription - // job; if the languages don't match, the language model isn't be applied. + // The name of the custom language model you want to use when processing your + // transcription job. Note that language model names are case sensitive. + // + // The language of the specified language model must match the language code + // you specify in your transcription request. If the languages don't match, + // the language model isn't applied. There are no errors or warnings associated + // with a language mismatch. LanguageModelName *string `min:"1" type:"string"` - // The name of the vocabulary filter you want to use when transcribing your - // audio. The filter you specify must have the same language codes as the transcription - // job; if the languages don't match, the vocabulary filter isn't be applied. + // The name of the custom vocabulary filter you want to use when processing + // your transcription job. Vocabulary filter names are case sensitive. + // + // The language of the specified vocabulary filter must match the language code + // you specify in your transcription request. If the languages don't match, + // the vocabulary filter isn't applied. There are no errors or warnings associated + // with a language mismatch. + // + // Note that if you include VocabularyFilterName in your request, you must also + // include VocabularyFilterMethod. VocabularyFilterName *string `min:"1" type:"string"` - // The name of the vocabulary you want to use when processing your transcription - // job. The vocabulary you specify must have the same language codes as the - // transcription job; if the languages don't match, the vocabulary isn't applied. + // The name of the custom vocabulary you want to use when processing your transcription + // job. Vocabulary names are case sensitive. + // + // The language of the specified vocabulary must match the language code you + // specify in your transcription request. If the languages don't match, the + // vocabulary isn't applied. There are no errors or warnings associated with + // a language mismatch. VocabularyName *string `min:"1" type:"string"` } @@ -7632,40 +8159,70 @@ func (s *LanguageIdSettings) SetVocabularyName(v string) *LanguageIdSettings { return s } -// The structure used to describe a custom language model. +// Provides information about a custom language model, including the base model +// name, when the model was created, the location of the files used to train +// the model, when the model was last modified, the name you chose for the model, +// its language, its processing state, and if there is an upgrade available +// for the base model. type LanguageModel struct { _ struct{} `type:"structure"` - // The Amazon Transcribe standard language model, or base model used to create - // the custom language model. + // The Amazon Transcribe standard language model, or base model, used to create + // your custom language model. BaseModelName *string `type:"string" enum:"BaseModelName"` - // The time the custom language model was created. + // The date and time the specified custom language model was created. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. CreateTime *time.Time `type:"timestamp"` - // The reason why the custom language model couldn't be created. + // If ModelStatus is FAILED, FailureReason contains information about why the + // custom language model request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The data access role and Amazon S3 prefixes for the input files used to train - // the custom language model. + // The Amazon S3 location of the input files used to train and tune your custom + // language model, in addition to the data access role ARN (Amazon Resource + // Name) that has permissions to access these data. InputDataConfig *InputDataConfig `type:"structure"` - // The language code you used to create your custom language model. + // The language code used to create your custom language model. Each language + // model must contain terms in only one language, and the language you select + // for your model must match the language of your training and tuning data. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. Note that U.S. English (en-US) is the only language supported with + // Amazon Transcribe Medical. LanguageCode *string `type:"string" enum:"CLMLanguageCode"` - // The most recent time the custom language model was modified. + // The date and time the specified language model was last modified. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the custom language model. + // A unique name, chosen by you, for your custom language model. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. ModelName *string `min:"1" type:"string"` - // The creation status of a custom language model. When the status is COMPLETED - // the model is ready for use. + // The status of the specified custom language model. When the status displays + // as COMPLETED the model is ready for use. ModelStatus *string `type:"string" enum:"ModelStatus"` - // Whether the base model used for the custom language model is up to date. - // If this field is false then you are running the most up-to-date version of - // the base model in your custom language model. + // Shows if a more current base model is available for use with the specified + // custom language model. + // + // If false, your language model is using the most up-to-date base model. + // + // If true, there is a newer base model available than the one your language + // model is using. + // + // Note that to update a base model, you must recreate the custom language model + // using the new base model. Base model upgrades for existing custom language + // models are not supported. UpgradeAvailability *bool `type:"boolean"` } @@ -7741,8 +8298,9 @@ func (s *LanguageModel) SetUpgradeAvailability(v bool) *LanguageModel { return s } -// Either you have sent too many requests or your input file is too long. Wait -// before you resend your request, or use a smaller file and resend the request. +// You've either sent too many requests or your input file is too long. Wait +// before retrying your request, or use a smaller file and try your request +// again. type LimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7809,13 +8367,17 @@ func (s *LimitExceededException) RequestID() string { type ListCallAnalyticsCategoriesInput struct { _ struct{} `type:"structure"` - // The maximum number of categories to return in each page of results. If there - // are fewer results than the value you specify, only the actual results are - // returned. If you do not specify a value, the default of 5 is used. + // The maximum number of Call Analytics categories to return in each page of + // results. If there are fewer results than the value you specify, only the + // actual results are returned. If you don't specify a value, a default of 5 + // is used. MaxResults *int64 `min:"1" type:"integer"` - // When included, NextTokenfetches the next set of categories if the result - // of the previous request was truncated. + // If your ListCallAnalyticsCategories request returns more results than can + // be displayed, NextToken is displayed in the response with an associated string. + // To get the next page of results, copy this string and repeat your request, + // including NextToken with the value of the copied string. Repeat as needed + // to view all your results. NextToken *string `type:"string"` } @@ -7865,14 +8427,15 @@ func (s *ListCallAnalyticsCategoriesInput) SetNextToken(v string) *ListCallAnaly type ListCallAnalyticsCategoriesOutput struct { _ struct{} `type:"structure"` - // A list of objects containing information about analytics categories. + // Provides detailed information about your Call Analytics categories, including + // all the rules associated with each category. Categories []*CategoryProperties `type:"list"` - // The operation returns a page of jobs at a time. The maximum size of the list - // is set by the MaxResults parameter. If there are more categories in the list - // than the page size, Amazon Transcribe returns the NextPage token. Include - // the token in the next request to the operation to return the next page of - // analytics categories. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` } @@ -7909,23 +8472,25 @@ func (s *ListCallAnalyticsCategoriesOutput) SetNextToken(v string) *ListCallAnal type ListCallAnalyticsJobsInput struct { _ struct{} `type:"structure"` - // When specified, the jobs returned in the list are limited to jobs whose name - // contains the specified string. + // Returns only the Call Analytics jobs that contain the specified string. The + // search is not case sensitive. JobNameContains *string `min:"1" type:"string"` - // The maximum number of call analytics jobs to return in each page of results. + // The maximum number of Call Analytics jobs to return in each page of results. // If there are fewer results than the value you specify, only the actual results - // are returned. If you do not specify a value, the default of 5 is used. + // are returned. If you don't specify a value, a default of 5 is used. MaxResults *int64 `min:"1" type:"integer"` - // If you receive a truncated result in the previous request of , include NextToken - // to fetch the next set of jobs. + // If your ListCallAnalyticsJobs request returns more results than can be displayed, + // NextToken is displayed in the response with an associated string. To get + // the next page of results, copy this string and repeat your request, including + // NextToken with the value of the copied string. Repeat as needed to view all + // your results. NextToken *string `type:"string"` - // When specified, returns only call analytics jobs with the specified status. - // Jobs are ordered by creation date, with the most recent jobs returned first. - // If you don't specify a status, Amazon Transcribe returns all analytics jobs - // ordered by creation date. + // Returns only Call Analytics jobs with the specified status. Jobs are ordered + // by creation date, with the newest job first. If you don't include Status, + // all Call Analytics jobs are returned. Status *string `type:"string" enum:"CallAnalyticsJobStatus"` } @@ -7990,19 +8555,18 @@ func (s *ListCallAnalyticsJobsInput) SetStatus(v string) *ListCallAnalyticsJobsI type ListCallAnalyticsJobsOutput struct { _ struct{} `type:"structure"` - // A list of objects containing summary information for a transcription job. + // Provides a summary of information about each result. CallAnalyticsJobSummaries []*CallAnalyticsJobSummary `type:"list"` - // The operation returns a page of jobs at a time. The maximum size of the page - // is set by the MaxResults parameter. If there are more jobs in the list than - // the page size, Amazon Transcribe returns the NextPage token. Include the - // token in your next request to the operation to return next page of jobs. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` - // When specified, returns only call analytics jobs with that status. Jobs are - // ordered by creation date, with the most recent jobs returned first. If you - // don't specify a status, Amazon Transcribe returns all transcription jobs - // ordered by creation date. + // Lists all Call Analytics jobs that have the status specified in your request. + // Jobs are ordered by creation date, with the newest job first. Status *string `type:"string" enum:"CallAnalyticsJobStatus"` } @@ -8045,23 +8609,25 @@ func (s *ListCallAnalyticsJobsOutput) SetStatus(v string) *ListCallAnalyticsJobs type ListLanguageModelsInput struct { _ struct{} `type:"structure"` - // The maximum number of language models to return in each page of results. + // The maximum number of custom language models to return in each page of results. // If there are fewer results than the value you specify, only the actual results - // are returned. If you do not specify a value, the default of 5 is used. + // are returned. If you don't specify a value, a default of 5 is used. MaxResults *int64 `min:"1" type:"integer"` - // When specified, the custom language model names returned contain the substring - // you've specified. + // Returns only the custom language models that contain the specified string. + // The search is not case sensitive. NameContains *string `min:"1" type:"string"` - // When included, fetches the next set of jobs if the result of the previous - // request was truncated. + // If your ListLanguageModels request returns more results than can be displayed, + // NextToken is displayed in the response with an associated string. To get + // the next page of results, copy this string and repeat your request, including + // NextToken with the value of the copied string. Repeat as needed to view all + // your results. NextToken *string `type:"string"` - // When specified, returns only custom language models with the specified status. - // Language models are ordered by creation date, with the newest models first. - // If you don't specify a status, Amazon Transcribe returns all custom language - // models ordered by date. + // Returns only custom language models with the specified status. Language models + // are ordered by creation date, with the newest model first. If you don't include + // StatusEquals, all custom language models are returned. StatusEquals *string `type:"string" enum:"ModelStatus"` } @@ -8126,14 +8692,15 @@ func (s *ListLanguageModelsInput) SetStatusEquals(v string) *ListLanguageModelsI type ListLanguageModelsOutput struct { _ struct{} `type:"structure"` - // A list of objects containing information about custom language models. + // Provides information about the custom language models that match the criteria + // specified in your request. Models []*LanguageModel `type:"list"` - // The operation returns a page of jobs at a time. The maximum size of the list - // is set by the MaxResults parameter. If there are more language models in - // the list than the page size, Amazon Transcribe returns the NextPage token. - // Include the token in the next request to the operation to return the next - // page of language models. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` } @@ -8170,24 +8737,26 @@ func (s *ListLanguageModelsOutput) SetNextToken(v string) *ListLanguageModelsOut type ListMedicalTranscriptionJobsInput struct { _ struct{} `type:"structure"` - // When specified, the jobs returned in the list are limited to jobs whose name - // contains the specified string. + // Returns only the medical transcription jobs that contain the specified string. + // The search is not case sensitive. JobNameContains *string `min:"1" type:"string"` // The maximum number of medical transcription jobs to return in each page of // results. If there are fewer results than the value you specify, only the - // actual results are returned. If you do not specify a value, the default of - // 5 is used. + // actual results are returned. If you don't specify a value, a default of 5 + // is used. MaxResults *int64 `min:"1" type:"integer"` - // If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, - // include NextToken to fetch the next set of jobs. + // If your ListMedicalTranscriptionJobs request returns more results than can + // be displayed, NextToken is displayed in the response with an associated string. + // To get the next page of results, copy this string and repeat your request, + // including NextToken with the value of the copied string. Repeat as needed + // to view all your results. NextToken *string `type:"string"` - // When specified, returns only medical transcription jobs with the specified - // status. Jobs are ordered by creation date, with the newest jobs returned - // first. If you don't specify a status, Amazon Transcribe Medical returns all - // transcription jobs ordered by creation date. + // Returns only medical transcription jobs with the specified status. Jobs are + // ordered by creation date, with the newest job first. If you don't include + // Status, all medical transcription jobs are returned. Status *string `type:"string" enum:"TranscriptionJobStatus"` } @@ -8252,17 +8821,18 @@ func (s *ListMedicalTranscriptionJobsInput) SetStatus(v string) *ListMedicalTran type ListMedicalTranscriptionJobsOutput struct { _ struct{} `type:"structure"` - // A list of objects containing summary information for a transcription job. + // Provides a summary of information about each result. MedicalTranscriptionJobSummaries []*MedicalTranscriptionJobSummary `type:"list"` - // The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. - // The maximum size of the page is set by the MaxResults parameter. If the number - // of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns - // the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs - // operation to return in the next page of jobs. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` - // The requested status of the medical transcription jobs returned. + // Lists all medical transcription jobs that have the status specified in your + // request. Jobs are ordered by creation date, with the newest job first. Status *string `type:"string" enum:"TranscriptionJobStatus"` } @@ -8305,23 +8875,26 @@ func (s *ListMedicalTranscriptionJobsOutput) SetStatus(v string) *ListMedicalTra type ListMedicalVocabulariesInput struct { _ struct{} `type:"structure"` - // The maximum number of vocabularies to return in each page of results. If - // there are fewer results than the value you specify, only the actual results - // are returned. If you do not specify a value, the default of 5 is used. + // The maximum number of custom medical vocabularies to return in each page + // of results. If there are fewer results than the value you specify, only the + // actual results are returned. If you don't specify a value, a default of 5 + // is used. MaxResults *int64 `min:"1" type:"integer"` - // Returns vocabularies whose names contain the specified string. The search - // is not case sensitive. ListMedicalVocabularies returns both "vocabularyname" - // and "VocabularyName". + // Returns only the custom medical vocabularies that contain the specified string. + // The search is not case sensitive. NameContains *string `min:"1" type:"string"` - // If the result of your previous request to ListMedicalVocabularies was truncated, - // include the NextToken to fetch the next set of vocabularies. + // If your ListMedicalVocabularies request returns more results than can be + // displayed, NextToken is displayed in the response with an associated string. + // To get the next page of results, copy this string and repeat your request, + // including NextToken with the value of the copied string. Repeat as needed + // to view all your results. NextToken *string `type:"string"` - // When specified, returns only vocabularies with the VocabularyState equal - // to the specified vocabulary state. Use this field to see which vocabularies - // are ready for your medical transcription jobs. + // Returns only custom medical vocabularies with the specified state. Vocabularies + // are ordered by creation date, with the newest vocabulary first. If you don't + // include StateEquals, all custom medical vocabularies are returned. StateEquals *string `type:"string" enum:"VocabularyState"` } @@ -8386,18 +8959,20 @@ func (s *ListMedicalVocabulariesInput) SetStateEquals(v string) *ListMedicalVoca type ListMedicalVocabulariesOutput struct { _ struct{} `type:"structure"` - // The ListMedicalVocabularies operation returns a page of vocabularies at a - // time. You set the maximum number of vocabularies to return on a page with - // the MaxResults parameter. If there are more jobs in the list will fit on - // a page, Amazon Transcribe Medical returns the NextPage token. To return the - // next page of vocabularies, include the token in the next request to the ListMedicalVocabularies - // operation. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` - // The requested vocabulary state. + // Lists all custom medical vocabularies that have the status specified in your + // request. Vocabularies are ordered by creation date, with the newest vocabulary + // first. Status *string `type:"string" enum:"VocabularyState"` - // A list of objects that describe the vocabularies that match your search criteria. + // Provides information about the custom medical vocabularies that match the + // criteria specified in your request. Vocabularies []*VocabularyInfo `type:"list"` } @@ -8440,9 +9015,11 @@ func (s *ListMedicalVocabulariesOutput) SetVocabularies(v []*VocabularyInfo) *Li type ListTagsForResourceInput struct { _ struct{} `type:"structure"` - // Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have - // the format arn:partition:service:region:account-id:resource-type/resource-id - // (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). + // Returns a list of all tags associated with the specified Amazon Resource + // Name (ARN). ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id. + // + // For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name. + // // Valid values for resource-type are: transcription-job, medical-transcription-job, // vocabulary, medical-vocabulary, vocabulary-filter, and language-model. // @@ -8493,11 +9070,11 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // Lists all tags associated with the given Amazon Resource Name (ARN). + // The Amazon Resource Name (ARN) specified in your request. ResourceArn *string `min:"1" type:"string"` - // Lists all tags associated with the given transcription job, vocabulary, or - // resource. + // Lists all tags associated with the given transcription job, vocabulary, model, + // or resource. Tags []*Tag `min:"1" type:"list"` } @@ -8534,23 +9111,25 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput type ListTranscriptionJobsInput struct { _ struct{} `type:"structure"` - // When specified, the jobs returned in the list are limited to jobs whose name - // contains the specified string. + // Returns only the transcription jobs that contain the specified string. The + // search is not case sensitive. JobNameContains *string `min:"1" type:"string"` - // The maximum number of jobs to return in each page of results. If there are - // fewer results than the value you specify, only the actual results are returned. - // If you do not specify a value, the default of 5 is used. + // The maximum number of transcription jobs to return in each page of results. + // If there are fewer results than the value you specify, only the actual results + // are returned. If you don't specify a value, a default of 5 is used. MaxResults *int64 `min:"1" type:"integer"` - // If the result of the previous request to ListTranscriptionJobs is truncated, - // include the NextToken to fetch the next set of jobs. + // If your ListTranscriptionJobs request returns more results than can be displayed, + // NextToken is displayed in the response with an associated string. To get + // the next page of results, copy this string and repeat your request, including + // NextToken with the value of the copied string. Repeat as needed to view all + // your results. NextToken *string `type:"string"` - // When specified, returns only transcription jobs with the specified status. - // Jobs are ordered by creation date, with the newest jobs returned first. If - // you don’t specify a status, Amazon Transcribe returns all transcription - // jobs ordered by creation date. + // Returns only transcription jobs with the specified status. Jobs are ordered + // by creation date, with the newest job first. If you don't include Status, + // all transcription jobs are returned. Status *string `type:"string" enum:"TranscriptionJobStatus"` } @@ -8615,17 +9194,18 @@ func (s *ListTranscriptionJobsInput) SetStatus(v string) *ListTranscriptionJobsI type ListTranscriptionJobsOutput struct { _ struct{} `type:"structure"` - // The ListTranscriptionJobs operation returns a page of jobs at a time. The - // maximum size of the page is set by the MaxResults parameter. If there are - // more jobs in the list than the page size, Amazon Transcribe returns the NextPage - // token. Include the token in the next request to the ListTranscriptionJobs - // operation to return in the next page of jobs. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` - // The requested status of the jobs returned. + // Lists all transcription jobs that have the status specified in your request. + // Jobs are ordered by creation date, with the newest job first. Status *string `type:"string" enum:"TranscriptionJobStatus"` - // A list of objects containing summary information for a transcription job. + // Provides a summary of information about each result. TranscriptionJobSummaries []*TranscriptionJobSummary `type:"list"` } @@ -8668,23 +9248,25 @@ func (s *ListTranscriptionJobsOutput) SetTranscriptionJobSummaries(v []*Transcri type ListVocabulariesInput struct { _ struct{} `type:"structure"` - // The maximum number of vocabularies to return in each page of results. If - // there are fewer results than the value you specify, only the actual results - // are returned. If you do not specify a value, the default of 5 is used. + // The maximum number of custom vocabularies to return in each page of results. + // If there are fewer results than the value you specify, only the actual results + // are returned. If you don't specify a value, a default of 5 is used. MaxResults *int64 `min:"1" type:"integer"` - // When specified, the vocabularies returned in the list are limited to vocabularies - // whose name contains the specified string. The search is not case sensitive, - // ListVocabularies returns both "vocabularyname" and "VocabularyName" in the - // response list. + // Returns only the custom vocabularies that contain the specified string. The + // search is not case sensitive. NameContains *string `min:"1" type:"string"` - // If the result of the previous request to ListVocabularies was truncated, - // include the NextToken to fetch the next set of jobs. + // If your ListVocabularies request returns more results than can be displayed, + // NextToken is displayed in the response with an associated string. To get + // the next page of results, copy this string and repeat your request, including + // NextToken with the value of the copied string. Repeat as needed to view all + // your results. NextToken *string `type:"string"` - // When specified, only returns vocabularies with the VocabularyState field - // equal to the specified state. + // Returns only custom vocabularies with the specified state. Vocabularies are + // ordered by creation date, with the newest vocabulary first. If you don't + // include StateEquals, all custom medical vocabularies are returned. StateEquals *string `type:"string" enum:"VocabularyState"` } @@ -8749,18 +9331,19 @@ func (s *ListVocabulariesInput) SetStateEquals(v string) *ListVocabulariesInput type ListVocabulariesOutput struct { _ struct{} `type:"structure"` - // The ListVocabularies operation returns a page of vocabularies at a time. - // The maximum size of the page is set in the MaxResults parameter. If there - // are more jobs in the list than will fit on the page, Amazon Transcribe returns - // the NextPage token. To return in the next page of jobs, include the token - // in the next request to the ListVocabularies operation. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` - // The requested vocabulary state. + // Lists all custom vocabularies that have the status specified in your request. + // Vocabularies are ordered by creation date, with the newest vocabulary first. Status *string `type:"string" enum:"VocabularyState"` - // A list of objects that describe the vocabularies that match the search criteria - // in the request. + // Provides information about the custom vocabularies that match the criteria + // specified in your request. Vocabularies []*VocabularyInfo `type:"list"` } @@ -8803,17 +9386,21 @@ func (s *ListVocabulariesOutput) SetVocabularies(v []*VocabularyInfo) *ListVocab type ListVocabularyFiltersInput struct { _ struct{} `type:"structure"` - // The maximum number of filters to return in each page of results. If there - // are fewer results than the value you specify, only the actual results are - // returned. If you do not specify a value, the default of 5 is used. + // The maximum number of custom vocabulary filters to return in each page of + // results. If there are fewer results than the value you specify, only the + // actual results are returned. If you don't specify a value, a default of 5 + // is used. MaxResults *int64 `min:"1" type:"integer"` - // Filters the response so that it only contains vocabulary filters whose name - // contains the specified string. + // Returns only the custom vocabulary filters that contain the specified string. + // The search is not case sensitive. NameContains *string `min:"1" type:"string"` - // If the result of the previous request to ListVocabularyFilters was truncated, - // include the NextToken to fetch the next set of collections. + // If your ListVocabularyFilters request returns more results than can be displayed, + // NextToken is displayed in the response with an associated string. To get + // the next page of results, copy this string and repeat your request, including + // NextToken with the value of the copied string. Repeat as needed to view all + // your results. NextToken *string `type:"string"` } @@ -8872,17 +9459,15 @@ func (s *ListVocabularyFiltersInput) SetNextToken(v string) *ListVocabularyFilte type ListVocabularyFiltersOutput struct { _ struct{} `type:"structure"` - // The ListVocabularyFilters operation returns a page of collections at a time. - // The maximum size of the page is set by the MaxResults parameter. If there - // are more jobs in the list than the page size, Amazon Transcribe returns the - // NextPage token. Include the token in the next request to the ListVocabularyFilters - // operation to return in the next page of jobs. + // If NextToken is present in your response, it indicates that not all results + // are displayed. To view the next set of results, copy the string associated + // with the NextToken parameter in your results output, then run your request + // again including NextToken with the value of the copied string. Repeat as + // needed to view all your results. NextToken *string `type:"string"` - // The list of vocabulary filters. It contains at most MaxResults number of - // filters. If there are more filters, call the ListVocabularyFilters operation - // again with the NextToken parameter in the request set to the value of the - // NextToken field in the response. + // Provides information about the custom vocabulary filters that match the criteria + // specified in your request. VocabularyFilters []*VocabularyFilterInfo `type:"list"` } @@ -8916,27 +9501,34 @@ func (s *ListVocabularyFiltersOutput) SetVocabularyFilters(v []*VocabularyFilter return s } -// Describes the input media file in a transcription request. +// Describes the Amazon S3 location of the media file you want to use in your +// request. type Media struct { _ struct{} `type:"structure"` - // The S3 object location of the input media file. The URI must be in the same - // region as the API endpoint that you are calling. The general form is: - // - // s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey + // The Amazon S3 location of the media file you want to transcribe. For example: // - // For example: + // * s3://DOC-EXAMPLE-BUCKET/my-media-file.flac // - // s3://DOC-EXAMPLE-BUCKET/example.flac + // * s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac // - // s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac - // - // For more information about S3 object names, see Object Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys) - // in the Amazon S3 Developer Guide. + // Note that the Amazon S3 bucket that contains your input media must be located + // in the same Amazon Web Services Region where you're making your transcription + // request. MediaFileUri *string `min:"1" type:"string"` - // The S3 object location for your redacted output media file. This is only - // supported for call analytics jobs. + // The Amazon S3 location of the media file you want to redact. For example: + // + // * s3://DOC-EXAMPLE-BUCKET/my-media-file.flac + // + // * s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac + // + // Note that the Amazon S3 bucket that contains your input media must be located + // in the same Amazon Web Services Region where you're making your transcription + // request. + // + // RedactedMediaFileUri is only supported for Call Analytics (StartCallAnalyticsJob) + // transcription requests. RedactedMediaFileUri *string `min:"1" type:"string"` } @@ -8986,14 +9578,24 @@ func (s *Media) SetRedactedMediaFileUri(v string) *Media { return s } -// Identifies the location of a medical transcript. +// Provides you with the Amazon S3 URI you can use to access your transcript. type MedicalTranscript struct { _ struct{} `type:"structure"` - // The S3 object location of the medical transcript. + // The Amazon S3 location of your transcript. You can use this URI to access + // or download your transcript. + // + // If you included OutputBucketName in your transcription job request, this + // is the URI of that bucket. If you also included OutputKey in your request, + // your output is located in the path you specified in your request. // - // Use this URI to access the medical transcript. This URI points to the S3 - // bucket you created to store the medical transcript. + // If you didn't include OutputBucketName in your transcription job request, + // your transcript is stored in a service-managed bucket, and TranscriptFileUri + // provides you with a temporary URI you can use for secure access to your transcript. + // + // Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 + // minutes. If you get an AccesDenied error, you can get a new temporary URI + // by running a GetTranscriptionJob or ListTranscriptionJob request. TranscriptFileUri *string `min:"1" type:"string"` } @@ -9021,104 +9623,114 @@ func (s *MedicalTranscript) SetTranscriptFileUri(v string) *MedicalTranscript { return s } -// The data structure that contains the information for a medical transcription -// job. +// Provides detailed information about a medical transcription job. +// +// To view the status of the specified medical transcription job, check the +// TranscriptionJobStatus field. If the status is COMPLETED, the job is finished +// and you can find the results at the location specified in TranscriptFileUri. +// If the status is FAILED, FailureReason provides details on why your transcription +// job failed. type MedicalTranscriptionJob struct { _ struct{} `type:"structure"` - // A timestamp that shows when the job was completed. + // The date and time the specified medical transcription job finished processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started + // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time `type:"timestamp"` - // Shows the type of content that you've configured Amazon Transcribe Medical - // to identify in a transcription job. If the value is PHI, you've configured - // the job to identify personal health information (PHI) in the transcription - // output. + // Labels all personal health information (PHI) identified in your transcript. + // For more information, see Identifying personal health information (PHI) in + // a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). ContentIdentificationType *string `type:"string" enum:"MedicalContentIdentificationType"` - // A timestamp that shows when the job was created. + // The date and time the specified medical transcription job request was made. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time `type:"timestamp"` - // If the TranscriptionJobStatus field is FAILED, this field contains information - // about why the job failed. + // If TranscriptionJobStatus is FAILED, FailureReason contains information about + // why the transcription job request failed. // // The FailureReason field contains one of the following values: // - // * Unsupported media format- The media format specified in the MediaFormat - // field of the request isn't valid. See the description of the MediaFormat - // field for a list of valid values. - // - // * The media format provided does not match the detected media format- - // The media format of the audio file doesn't match the format specified - // in the MediaFormat field in the request. Check the media format of your - // media file and make sure the two values match. - // - // * Invalid sample rate for audio file- The sample rate specified in the - // MediaSampleRateHertz of the request isn't valid. The sample rate must - // be between 8,000 and 48,000 Hertz. - // - // * The sample rate provided does not match the detected sample rate- The - // sample rate in the audio file doesn't match the sample rate specified - // in the MediaSampleRateHertz field in the request. Check the sample rate - // of your media file and make sure that the two values match. - // - // * Invalid file size: file size too large- The size of your audio file - // is larger than what Amazon Transcribe Medical can process. For more information, - // see Guidelines and Quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) - // in the Amazon Transcribe Medical Guide. - // - // * Invalid number of channels: number of channels too large- Your audio - // contains more channels than Amazon Transcribe Medical is configured to - // process. To request additional channels, see Amazon Transcribe Medical - // Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html) - // in the Amazon Web Services General Reference. + // * Unsupported media format. The media format specified in MediaFormat + // isn't valid. Refer to MediaFormat for a list of supported formats. + // + // * The media format provided does not match the detected media format. + // The media format specified in MediaFormat doesn't match the format of + // the input file. Check the media format of your media file and correct + // the specified value. + // + // * Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz + // isn't valid. The sample rate must be between 16,000 and 48,000 Hertz. + // + // * The sample rate provided does not match the detected sample rate. The + // sample rate specified in MediaSampleRateHertz doesn't match the sample + // rate detected in your input media file. Check the sample rate of your + // media file and correct the specified value. + // + // * Invalid file size: file size too large. The size of your media file + // is larger than what Amazon Transcribe can process. For more information, + // refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). + // + // * Invalid number of channels: number of channels too large. Your audio + // contains more channels than Amazon Transcribe is able to process. For + // more information, refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). FailureReason *string `type:"string"` - // The language code for the language spoken in the source audio file. US English - // (en-US) is the only supported language for medical transcriptions. Any other - // value you enter for language code results in a BadRequestException error. + // The language code used to create your medical transcription job. US English + // (en-US) is the only supported language for medical transcriptions. LanguageCode *string `type:"string" enum:"LanguageCode"` - // Describes the input media file in a transcription request. + // Describes the Amazon S3 location of the media file you want to use in your + // request. Media *Media `type:"structure"` // The format of the input media file. MediaFormat *string `type:"string" enum:"MediaFormat"` - // The sample rate, in Hertz, of the source audio containing medical information. - // - // If you don't specify the sample rate, Amazon Transcribe Medical determines - // it for you. If you choose to specify the sample rate, it must match the rate - // detected by Amazon Transcribe Medical. + // The sample rate, in Hertz, of the audio track in your input media file. MediaSampleRateHertz *int64 `min:"16000" type:"integer"` - // The name for a given medical transcription job. + // The name of the medical transcription job. Job names are case sensitive and + // must be unique within an Amazon Web Services account. MedicalTranscriptionJobName *string `min:"1" type:"string"` - // Object that contains object. + // Specify additional optional settings in your request, including channel identification, + // alternative transcriptions, and speaker labeling; allows you to apply custom + // vocabularies to your medical transcription job. Settings *MedicalTranscriptionSetting `type:"structure"` - // The medical specialty of any clinicians providing a dictation or having a - // conversation. Refer to Transcribing a medical conversation (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html)for - // a list of supported specialties. + // Describes the medical specialty represented in your media. Specialty *string `type:"string" enum:"Specialty"` - // A timestamp that shows when the job started processing. + // The date and time the specified medical transcription job began processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time `type:"timestamp"` - // A key:value pair assigned to a given medical transcription job. + // The tags, each in the form of a key:value pair, assigned to the specified + // medical transcription job. Tags []*Tag `min:"1" type:"list"` - // An object that contains the MedicalTranscript. The MedicalTranscript contains - // the TranscriptFileUri. + // Provides you with the Amazon S3 URI you can use to access your transcript. Transcript *MedicalTranscript `type:"structure"` - // The completion status of a medical transcription job. + // Provides the status of the specified medical transcription job. + // + // If the status is COMPLETED, the job is finished and you can find the results + // at the location specified in TranscriptFileUri. If the status is FAILED, + // FailureReason provides details on why your transcription job failed. TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"` - // The type of speech in the transcription job. CONVERSATION is generally used - // for patient-physician dialogues. DICTATION is the setting for physicians - // speaking their notes after seeing a patient. For more information, see What - // is Amazon Transcribe Medical? (https://docs.aws.amazon.com/transcribe/latest/dg/what-is-transcribe-med.html). + // Indicates whether the input media is a dictation or a conversation, as specified + // in the StartMedicalTranscriptionJob request. Type *string `type:"string" enum:"Type"` } @@ -9236,47 +9848,72 @@ func (s *MedicalTranscriptionJob) SetType(v string) *MedicalTranscriptionJob { return s } -// Provides summary information about a transcription job. +// Provides detailed information about a specific medical transcription job. type MedicalTranscriptionJobSummary struct { _ struct{} `type:"structure"` - // A timestamp that shows when the job was completed. + // The date and time the specified medical transcription job finished processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started + // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time `type:"timestamp"` - // Shows the type of information you've configured Amazon Transcribe Medical - // to identify in a transcription job. If the value is PHI, you've configured - // the transcription job to identify personal health information (PHI). + // Labels all personal health information (PHI) identified in your transcript. + // For more information, see Identifying personal health information (PHI) in + // a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). ContentIdentificationType *string `type:"string" enum:"MedicalContentIdentificationType"` - // A timestamp that shows when the medical transcription job was created. + // The date and time the specified medical transcription job request was made. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time `type:"timestamp"` - // If the TranscriptionJobStatus field is FAILED, a description of the error. + // If TranscriptionJobStatus is FAILED, FailureReason contains information about + // why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // The language of the transcript in the source audio file. + // The language code used to create your medical transcription. US English (en-US) + // is the only supported language for medical transcriptions. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The name of a medical transcription job. + // The name of the medical transcription job. Job names are case sensitive and + // must be unique within an Amazon Web Services account. MedicalTranscriptionJobName *string `min:"1" type:"string"` - // Indicates the location of the transcription job's output. This field must - // be the path of an S3 bucket; if you don't already have an S3 bucket, one - // is created based on the path you add. + // Indicates where the specified medical transcription output is stored. + // + // If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you + // specified using the OutputBucketName parameter in your request. If you also + // included OutputKey in your request, your output is located in the path you + // specified in your request. + // + // If the value is SERVICE_BUCKET, the location is a service-managed Amazon + // S3 bucket. To access a transcript stored in a service-managed bucket, use + // the URI shown in the TranscriptFileUri field. OutputLocationType *string `type:"string" enum:"OutputLocationType"` - // The medical specialty of the transcription job. Refer to Transcribing a medical - // conversation (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html)for - // a list of supported specialties. + // Provides the medical specialty represented in your media. Specialty *string `type:"string" enum:"Specialty"` - // A timestamp that shows when the job began processing. + // The date and time your medical transcription job began processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time `type:"timestamp"` - // The status of the medical transcription job. + // Provides the status of your medical transcription job. + // + // If the status is COMPLETED, the job is finished and you can find the results + // at the location specified in TranscriptFileUri. If the status is FAILED, + // FailureReason provides details on why your transcription job failed. TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"` - // The speech of the clinician in the input audio. + // Indicates whether the input media is a dictation or a conversation, as specified + // in the StartMedicalTranscriptionJob request. Type *string `type:"string" enum:"Type"` } @@ -9364,51 +10001,79 @@ func (s *MedicalTranscriptionJobSummary) SetType(v string) *MedicalTranscription return s } -// Optional settings for the StartMedicalTranscriptionJob operation. +// Allows additional optional settings in your request, including channel identification, +// alternative transcriptions, and speaker labeling; allows you to apply custom +// vocabularies to your medical transcription job. type MedicalTranscriptionSetting struct { _ struct{} `type:"structure"` - // Instructs Amazon Transcribe Medical to process each audio channel separately - // and then merge the transcription output of each channel into a single transcription. + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for each channel into one transcript. // - // Amazon Transcribe Medical also produces a transcription of each item detected - // on an audio channel, including the start time and end time of the item and - // alternative transcriptions of item. The alternative transcriptions also come - // with confidence scores provided by Amazon Transcribe Medical. + // If you have multi-channel audio and do not enable channel identification, + // your audio is transcribed in a continuous manner and your transcript does + // not separate the speech by channel. // - // You can't set both ShowSpeakerLabels and ChannelIdentification in the same - // request. If you set both, your request returns a BadRequestException. + // You can't include both ShowSpeakerLabels and ChannelIdentification in the + // same request. Including both parameters returns a BadRequestException. + // + // For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). ChannelIdentification *bool `type:"boolean"` - // The maximum number of alternatives that you tell the service to return. If - // you specify the MaxAlternatives field, you must set the ShowAlternatives - // field to true. + // Indicate the maximum number of alternative transcriptions you want Amazon + // Transcribe Medical to include in your transcript. + // + // If you select a number greater than the number of alternative transcriptions + // generated by Amazon Transcribe Medical, only the actual number of alternative + // transcriptions are included. + // + // If you include MaxAlternatives in your request, you must also include ShowAlternatives + // with a value of true. + // + // For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). MaxAlternatives *int64 `min:"2" type:"integer"` - // The maximum number of speakers to identify in the input audio. If there are - // more speakers in the audio than this number, multiple speakers are identified - // as a single speaker. If you specify the MaxSpeakerLabels field, you must - // set the ShowSpeakerLabels field to true. + // Specify the maximum number of speakers you want to identify in your media. + // + // Note that if your media contains more speakers than the specified number, + // multiple speakers will be identified as a single speaker. + // + // If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels + // field to true. MaxSpeakerLabels *int64 `min:"2" type:"integer"` - // Determines whether alternative transcripts are generated along with the transcript - // that has the highest confidence. If you set ShowAlternatives field to true, - // you must also set the maximum number of alternatives to return in the MaxAlternatives - // field. + // To include alternative transcriptions within your transcription output, include + // ShowAlternatives in your transcription request. + // + // If you include ShowAlternatives, you must also include MaxAlternatives, which + // is the maximum number of alternative transcriptions you want Amazon Transcribe + // Medical to generate. + // + // For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). ShowAlternatives *bool `type:"boolean"` - // Determines whether the transcription job uses speaker recognition to identify - // different speakers in the input audio. Speaker recognition labels individual - // speakers in the audio file. If you set the ShowSpeakerLabels field to true, - // you must also set the maximum number of speaker labels in the MaxSpeakerLabels - // field. + // Enables speaker identification (diarization) in your transcription output. + // Speaker identification labels the speech from individual speakers in your + // media file. + // + // If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. + // + // You can't include both ShowSpeakerLabels and ChannelIdentification in the + // same request. Including both parameters returns a BadRequestException. // - // You can't set both ShowSpeakerLabels and ChannelIdentification in the same - // request. If you set both, your request returns a BadRequestException. + // For more information, see Identifying speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). ShowSpeakerLabels *bool `type:"boolean"` - // The name of the vocabulary to use when processing a medical transcription - // job. + // The name of the custom vocabulary you want to use when processing your medical + // transcription job. Vocabulary names are case sensitive. + // + // The language of the specified vocabulary must match the language code you + // specify in your transcription request. If the languages don't match, the + // vocabulary isn't applied. There are no errors or warnings associated with + // a language mismatch. US English (en-US) is the only valid language for Amazon + // Transcribe Medical. VocabularyName *string `min:"1" type:"string"` } @@ -9485,12 +10150,22 @@ func (s *MedicalTranscriptionSetting) SetVocabularyName(v string) *MedicalTransc return s } -// The object used to call your custom language model to your transcription -// job. +// Provides the name of the custom language model that was included in the specified +// transcription job. +// +// Only use ModelSettings with the LanguageModelName sub-parameter if you're +// not using automatic language identification (). If using LanguageIdSettings +// in your request, this parameter contains a LanguageModelName sub-parameter. type ModelSettings struct { _ struct{} `type:"structure"` - // The name of your custom language model. + // The name of the custom language model you want to use when processing your + // transcription job. Note that language model names are case sensitive. + // + // The language of the specified language model must match the language code + // you specify in your transcription request. If the languages don't match, + // the language model isn't applied. There are no errors or warnings associated + // with a language mismatch. LanguageModelName *string `min:"1" type:"string"` } @@ -9531,28 +10206,33 @@ func (s *ModelSettings) SetLanguageModelName(v string) *ModelSettings { return s } -// An object that enables you to configure your category to be applied to call -// analytics jobs where either the customer or agent was interrupted. +// Flag the presence or absence of periods of silence in your Call Analytics +// transcription output. +// +// Rules using NonTalkTimeFilter are designed to match: +// +// * The presence of silence at specified periods throughout the call +// +// * The presence of speech at specified periods throughout the call +// +// See Rule criteria (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules) +// for usage examples. type NonTalkTimeFilter struct { _ struct{} `type:"structure"` - // An object you can use to specify a time range (in milliseconds) for when - // no one is talking. For example, you could specify a time period between the - // 30,000 millisecond mark and the 45,000 millisecond mark. You could also specify - // the time period as the first 15,000 milliseconds or the last 15,000 milliseconds. + // Allows you to specify a time range (in milliseconds) in your audio, during + // which you want to search for a period of silence. See for more detail. AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"` - // Set to TRUE to look for a time period when people were talking. + // Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence Negate *bool `type:"boolean"` - // An object that allows percentages to specify the proportion of the call where - // there was silence. For example, you can specify the first half of the call. - // You can also specify the period of time between halfway through to three-quarters - // of the way through the call. Because the length of conversation can vary - // between calls, you can apply relative time ranges across all calls. + // Allows you to specify a time range (in percentage) in your media file, during + // which you want to search for a period of silence. See for more detail. RelativeTimeRange *RelativeTimeRange `type:"structure"` - // The duration of the period when neither the customer nor agent was talking. + // Specify the duration, in milliseconds, of the period of silence you want + // to flag. For example, you can flag a silent period that lasts 30000 milliseconds. Threshold *int64 `type:"long"` } @@ -9598,8 +10278,8 @@ func (s *NonTalkTimeFilter) SetThreshold(v int64) *NonTalkTimeFilter { return s } -// We can't find the requested resource. Check the name and try your request -// again. +// We can't find the requested resource. Check that the specified name is correct +// and try your request again. type NotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -9663,52 +10343,39 @@ func (s *NotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// An object that allows percentages to specify the proportion of the call where -// you would like to apply a filter. For example, you can specify the first -// half of the call. You can also specify the period of time between halfway -// through to three-quarters of the way through the call. Because the length -// of conversation can vary between calls, you can apply relative time ranges -// across all calls. +// A time range, in percentage, between two points in your media file. +// +// You can use StartPercentage and EndPercentage to search a custom segment. +// For example, setting StartPercentage to 10 and EndPercentage to 50 only searches +// for your specified criteria in the audio contained between the 10 percent +// mark and the 50 percent mark of your media file. +// +// You can use also First to search from the start of the media file until the +// time you specify, or Last to search from the time you specify until the end +// of the media file. For example, setting First to 10 only searches for your +// specified criteria in the audio contained in the first 10 percent of the +// media file. +// +// If you prefer to use milliseconds instead of percentage, see . type RelativeTimeRange struct { _ struct{} `type:"structure"` - // A value that indicates the percentage of the end of the time range. To set - // a relative time range, you must specify a start percentage and an end percentage. - // For example, if you specify the following values: - // - // * StartPercentage - 10 - // - // * EndPercentage - 50 - // - // This looks at the time range starting from 10% of the way into the call to - // 50% of the way through the call. For a call that lasts 100,000 milliseconds, - // this example range would apply from the 10,000 millisecond mark to the 50,000 - // millisecond mark. + // The time, in percentage, when Amazon Transcribe stops searching for the specified + // criteria in your media file. If you include EndPercentage in your request, + // you must also include StartPercentage. EndPercentage *int64 `type:"integer"` - // A range that takes the portion of the call up to the time in milliseconds - // set by the value that you've specified. For example, if you specify 120000, - // the time range is set for the first 120,000 milliseconds of the call. + // The time, in percentage, from the start of your media file until the value + // you specify in which Amazon Transcribe searches for your specified criteria. First *int64 `type:"integer"` - // A range that takes the portion of the call from the time in milliseconds - // set by the value that you've specified to the end of the call. For example, - // if you specify 120000, the time range is set for the last 120,000 milliseconds - // of the call. + // The time, in percentage, from the value you specify until the end of your + // media file in which Amazon Transcribe searches for your specified criteria. Last *int64 `type:"integer"` - // A value that indicates the percentage of the beginning of the time range. - // To set a relative time range, you must specify a start percentage and an - // end percentage. For example, if you specify the following values: - // - // * StartPercentage - 10 - // - // * EndPercentage - 50 - // - // This looks at the time range starting from 10% of the way into the call to - // 50% of the way through the call. For a call that lasts 100,000 milliseconds, - // this example range would apply from the 10,000 millisecond mark to the 50,000 - // millisecond mark. + // The time, in percentage, when Amazon Transcribe starts searching for the + // specified criteria in your media file. If you include StartPercentage in + // your request, you must also include EndPercentage. StartPercentage *int64 `type:"integer"` } @@ -9754,25 +10421,33 @@ func (s *RelativeTimeRange) SetStartPercentage(v int64) *RelativeTimeRange { return s } -// A condition in the call between the customer and the agent that you want -// to filter for. +// A rule is a set of criteria you can specify to flag an attribute in your +// Call Analytics output. Rules define a Call Analytics category. +// +// Rules can include these parameters: , , , and . To learn more about these +// parameters, refer to Rule criteria (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules). +// +// To learn more about Call Analytics categories, see Creating categories (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html). +// +// To learn more about Call Analytics, see Analyzing call center audio with +// Call Analytics (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html). type Rule struct { _ struct{} `type:"structure"` - // A condition for a time period when either the customer or agent was interrupting - // the other person. + // Flag the presence or absence of interruptions in your Call Analytics transcription + // output. Refer to for more detail. InterruptionFilter *InterruptionFilter `type:"structure"` - // A condition for a time period when neither the customer nor the agent was - // talking. + // Flag the presence or absence of periods of silence in your Call Analytics + // transcription output. Refer to for more detail. NonTalkTimeFilter *NonTalkTimeFilter `type:"structure"` - // A condition that is applied to a particular customer sentiment. + // Flag the presence or absence of specific sentiments in your Call Analytics + // transcription output. Refer to for more detail. SentimentFilter *SentimentFilter `type:"structure"` - // A condition that catches particular words or phrases based on a exact match. - // For example, if you set the phrase "I want to speak to the manager", only - // that exact phrase will be returned. + // Flag the presence or absence of specific words or phrases in your Call Analytics + // transcription output. Refer to for more detail. TranscriptFilter *TranscriptFilter `type:"structure"` } @@ -9838,29 +10513,45 @@ func (s *Rule) SetTranscriptFilter(v *TranscriptFilter) *Rule { return s } -// An object that enables you to specify a particular customer or agent sentiment. -// If at least 50 percent of the conversation turns (the back-and-forth between -// two speakers) in a specified time period match the specified sentiment, Amazon -// Transcribe will consider the sentiment a match. +// Flag the presence or absence of specific sentiments detected in your Call +// Analytics transcription output. +// +// Rules using SentimentFilter are designed to match: +// +// * The presence or absence of a positive sentiment felt by the customer, +// agent, or both at specified points in the call +// +// * The presence or absence of a negative sentiment felt by the customer, +// agent, or both at specified points in the call +// +// * The presence or absence of a neutral sentiment felt by the customer, +// agent, or both at specified points in the call +// +// * The presence or absence of a mixed sentiment felt by the customer, the +// agent, or both at specified points in the call +// +// See Rule criteria (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules) +// for examples. type SentimentFilter struct { _ struct{} `type:"structure"` - // The time range, measured in seconds, of the sentiment. + // Allows you to specify a time range (in milliseconds) in your audio, during + // which you want to search for the specified sentiments. See for more detail. AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"` - // Set to TRUE to look for sentiments that weren't specified in the request. + // Set to TRUE to flag the sentiments you didn't include in your request. Set + // to FALSE to flag the sentiments you specified in your request. Negate *bool `type:"boolean"` - // A value that determines whether the sentiment belongs to the customer or - // the agent. + // Specify the participant you want to flag. Omitting this parameter is equivalent + // to specifying both participants. ParticipantRole *string `type:"string" enum:"ParticipantRole"` - // The time range, set in percentages, that correspond to proportion of the - // call. + // Allows you to specify a time range (in percentage) in your media file, during + // which you want to search for the specified sentiments. See for more detail. RelativeTimeRange *RelativeTimeRange `type:"structure"` - // An array that enables you to specify sentiments for the customer or agent. - // You can specify one or more values. + // Specify the sentiments you want to flag. // // Sentiments is a required field Sentiments []*string `min:"1" type:"list" required:"true" enum:"SentimentValue"` @@ -9930,61 +10621,91 @@ func (s *SentimentFilter) SetSentiments(v []*string) *SentimentFilter { return s } -// Provides optional settings for the StartTranscriptionJob operation. +// Allows additional optional settings in your request, including channel identification, +// alternative transcriptions, and speaker labeling; allows you to apply custom +// vocabularies to your transcription job. type Settings struct { _ struct{} `type:"structure"` - // Instructs Amazon Transcribe to process each audio channel separately and - // then merge the transcription output of each channel into a single transcription. + // Enables channel identification in multi-channel audio. + // + // Channel identification transcribes the audio on each channel independently, + // then appends the output for each channel into one transcript. // - // Amazon Transcribe also produces a transcription of each item detected on - // an audio channel, including the start time and end time of the item and alternative - // transcriptions of the item including the confidence that Amazon Transcribe - // has in the transcription. + // You can't include both ShowSpeakerLabels and ChannelIdentification in the + // same request. Including both parameters returns a BadRequestException. // - // You can't set both ShowSpeakerLabels and ChannelIdentification in the same - // request. If you set both, your request returns a BadRequestException. + // For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). ChannelIdentification *bool `type:"boolean"` - // The number of alternative transcriptions that the service should return. - // If you specify the MaxAlternatives field, you must set the ShowAlternatives - // field to true. + // Indicate the maximum number of alternative transcriptions you want Amazon + // Transcribe to include in your transcript. + // + // If you select a number greater than the number of alternative transcriptions + // generated by Amazon Transcribe, only the actual number of alternative transcriptions + // are included. + // + // If you include MaxAlternatives in your request, you must also include ShowAlternatives + // with a value of true. + // + // For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). MaxAlternatives *int64 `min:"2" type:"integer"` - // The maximum number of speakers to identify in the input audio. If there are - // more speakers in the audio than this number, multiple speakers are identified - // as a single speaker. If you specify the MaxSpeakerLabels field, you must - // set the ShowSpeakerLabels field to true. + // Specify the maximum number of speakers you want to identify in your media. + // + // Note that if your media contains more speakers than the specified number, + // multiple speakers will be identified as a single speaker. + // + // If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels + // field to true. MaxSpeakerLabels *int64 `min:"2" type:"integer"` - // Determines whether the transcription contains alternative transcriptions. - // If you set the ShowAlternatives field to true, you must also set the maximum - // number of alternatives to return in the MaxAlternatives field. + // To include alternative transcriptions within your transcription output, include + // ShowAlternatives in your transcription request. + // + // If you have multi-channel audio and do not enable channel identification, + // your audio is transcribed in a continuous manner and your transcript does + // not separate the speech by channel. + // + // If you include ShowAlternatives, you must also include MaxAlternatives, which + // is the maximum number of alternative transcriptions you want Amazon Transcribe + // to generate. + // + // For more information, see Alternative transcriptions (https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html). ShowAlternatives *bool `type:"boolean"` - // Determines whether the transcription job uses speaker recognition to identify - // different speakers in the input audio. Speaker recognition labels individual - // speakers in the audio file. If you set the ShowSpeakerLabels field to true, - // you must also set the maximum number of speaker labels MaxSpeakerLabels field. + // Enables speaker identification (diarization) in your transcription output. + // Speaker identification labels the speech from individual speakers in your + // media file. + // + // If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. + // + // You can't include both ShowSpeakerLabels and ChannelIdentification in the + // same request. Including both parameters returns a BadRequestException. // - // You can't set both ShowSpeakerLabels and ChannelIdentification in the same - // request. If you set both, your request returns a BadRequestException. + // For more information, see Identifying speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). ShowSpeakerLabels *bool `type:"boolean"` - // Set to mask to remove filtered text from the transcript and replace it with - // three asterisks ("***") as placeholder text. Set to remove to remove filtered - // text from the transcript without using placeholder text. Set to tag to mark - // the word in the transcription output that matches the vocabulary filter. - // When you set the filter method to tag, the words matching your vocabulary - // filter are not masked or removed. + // Specify how you want your vocabulary filter applied to your transcript. + // + // To replace words with ***, choose mask. + // + // To delete words, choose remove. + // + // To flag words without changing them, choose tag. VocabularyFilterMethod *string `type:"string" enum:"VocabularyFilterMethod"` - // The name of the vocabulary filter to use when transcribing the audio. The - // filter that you specify must have the same language code as the transcription - // job. + // The name of the custom vocabulary filter you want to use in your transcription + // job request. This name is case sensitive, cannot contain spaces, and must + // be unique within an Amazon Web Services account. + // + // Note that if you include VocabularyFilterName in your request, you must also + // include VocabularyFilterMethod. VocabularyFilterName *string `min:"1" type:"string"` - // The name of a vocabulary to use when processing the transcription job. + // The name of the custom vocabulary you want to use in your transcription job + // request. This name is case sensitive, cannot contain spaces, and must be + // unique within an Amazon Web Services account. VocabularyName *string `min:"1" type:"string"` } @@ -10079,83 +10800,93 @@ func (s *Settings) SetVocabularyName(v string) *Settings { type StartCallAnalyticsJobInput struct { _ struct{} `type:"structure"` - // The name of the call analytics job. You can't use the string "." or ".." - // by themselves as the job name. The name must also be unique within an Amazon - // Web Services account. If you try to create a call analytics job with the - // same name as a previous call analytics job, you get a ConflictException error. + // A unique name, chosen by you, for your Call Analytics job. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // CallAnalyticsJobName is a required field CallAnalyticsJobName *string `min:"1" type:"string" required:"true"` - // When you start a call analytics job, you must pass an array that maps the - // agent and the customer to specific audio channels. The values you can assign - // to a channel are 0 and 1. The agent and the customer must each have their - // own channel. You can't assign more than one channel to an agent or customer. + // Allows you to specify which speaker is on which channel. For example, if + // your agent is the first participant to speak, you would set ChannelId to + // 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate + // that it's the agent speaking). ChannelDefinitions []*ChannelDefinition `min:"2" type:"list"` - // The Amazon Resource Name (ARN) of a role that has access to the S3 bucket - // that contains your input files. Amazon Transcribe assumes this role to read - // queued audio files. If you have specified an output S3 bucket for your transcription - // results, this role should have access to the output bucket as well. + // The Amazon Resource Name (ARN) of an IAM role that has permissions to access + // the Amazon S3 bucket that contains your input files. If the role you specify + // doesn’t have the appropriate permissions to access the specified Amazon + // S3 location, your request fails. // - // DataAccessRoleArn is a required field - DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + // IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. + // For example: arn:aws:iam::111122223333:role/Admin. + // + // For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). + DataAccessRoleArn *string `min:"20" type:"string"` - // Describes the input media file in a transcription request. + // Describes the Amazon S3 location of the media file you want to use in your + // request. // // Media is a required field Media *Media `type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the Amazon Web Services Key Management - // Service key used to encrypt the output of the call analytics job. The user - // calling the operation must have permission to use the specified KMS key. + // The KMS key you want to use to encrypt your Call Analytics output. + // + // If using a key located in the current Amazon Web Services account, you can + // specify your KMS key in one of four ways: + // + // Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. // - // You use either of the following to identify an Amazon Web Services KMS key - // in the current account: + // Use an alias for the KMS key ID. For example, alias/ExampleAlias. // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. // - // * KMS Key Alias: "alias/ExampleAlias" + // Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. // - // You can use either of the following to identify a KMS key in the current - // account or another account: + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one + // of two ways: // - // * Amazon Resource Name (ARN) of a KMS key in the current account or another - // account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab" + // Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. // - // * ARN of a KMS Key Alias: "arn:aws:kms:region:accountID:alias/ExampleAlias" + // Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. // - // If you don't specify an encryption key, the output of the call analytics - // job is encrypted with the default Amazon S3 key (SSE-S3). + // If you don't specify an encryption key, your output is encrypted with the + // default Amazon S3 key (SSE-S3). // // If you specify a KMS key to encrypt your output, you must also specify an - // output location in the OutputLocation parameter. + // output location using the OutputLocation parameter. + // + // Note that the user making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string `min:"1" type:"string"` - // The Amazon S3 location where the output of the call analytics job is stored. - // You can provide the following location types to store the output of call - // analytics job: + // The Amazon S3 location where you want your Call Analytics transcription output + // stored. You can use any of the following formats to specify the output location: + // + // s3://DOC-EXAMPLE-BUCKET // - // * s3://DOC-EXAMPLE-BUCKET1 If you specify a bucket, Amazon Transcribe - // saves the output of the analytics job as a JSON file at the root level - // of the bucket. + // s3://DOC-EXAMPLE-BUCKET/my-output-folder/ // - // * s3://DOC-EXAMPLE-BUCKET1/folder/ f you specify a path, Amazon Transcribe - // saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json. - // If you specify a folder, you must provide a trailing slash. + // s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json // - // * s3://DOC-EXAMPLE-BUCKET1/folder/filename.json. If you provide a path - // that has the filename specified, Amazon Transcribe saves the output of - // the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json. + // Unless you specify a file name (option 3), the name of your output file has + // a default value that matches the name you specified for your transcription + // job using the CallAnalyticsJobName parameter. // - // You can specify an Amazon Web Services Key Management Service (KMS) key to - // encrypt the output of our analytics job using the OutputEncryptionKMSKeyId + // You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId // parameter. If you don't specify a KMS key, Amazon Transcribe uses the default - // Amazon S3 key for server-side encryption of the analytics job output that - // is placed in your S3 bucket. + // Amazon S3 key for server-side encryption. + // + // If you don't specify OutputLocation, your transcript is placed in a service-managed + // Amazon S3 bucket and you are provided with a URI to access your transcript. OutputLocation *string `min:"1" type:"string"` - // A Settings object that provides optional settings for a call analytics job. + // Specify additional optional settings in your request, including content redaction; + // allows you to apply custom language models, vocabulary filters, and custom + // vocabularies to your Call Analytics job. Settings *CallAnalyticsJobSettings `type:"structure"` } @@ -10189,9 +10920,6 @@ func (s *StartCallAnalyticsJobInput) Validate() error { if s.ChannelDefinitions != nil && len(s.ChannelDefinitions) < 2 { invalidParams.Add(request.NewErrParamMinLen("ChannelDefinitions", 2)) } - if s.DataAccessRoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("DataAccessRoleArn")) - } if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) } @@ -10266,7 +10994,8 @@ func (s *StartCallAnalyticsJobInput) SetSettings(v *CallAnalyticsJobSettings) *S type StartCallAnalyticsJobOutput struct { _ struct{} `type:"structure"` - // An object containing the details of the asynchronous call analytics job. + // Provides detailed information about the current Call Analytics job, including + // job status and, if applicable, failure reason. CallAnalyticsJob *CallAnalyticsJob `type:"structure"` } @@ -10297,123 +11026,160 @@ func (s *StartCallAnalyticsJobOutput) SetCallAnalyticsJob(v *CallAnalyticsJob) * type StartMedicalTranscriptionJobInput struct { _ struct{} `type:"structure"` - // You can configure Amazon Transcribe Medical to label content in the transcription - // output. If you specify PHI, Amazon Transcribe Medical labels the personal - // health information (PHI) that it identifies in the transcription output. + // Labels all personal health information (PHI) identified in your transcript. + // For more information, see Identifying personal health information (PHI) in + // a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). ContentIdentificationType *string `type:"string" enum:"MedicalContentIdentificationType"` // A map of plain text, non-secret key:value pairs, known as encryption context - // pairs, that provide an added layer of security for your data. + // pairs, that provide an added layer of security for your data. For more information, + // see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) + // and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html). KMSEncryptionContext map[string]*string `min:"1" type:"map"` - // The language code for the language spoken in the input media file. US English - // (en-US) is the valid value for medical transcription jobs. Any other value - // you enter for language code results in a BadRequestException error. + // The language code that represents the language spoken in the input media + // file. US English (en-US) is the only valid value for medical transcription + // jobs. Any other value you enter for language code results in a BadRequestException + // error. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // Describes the input media file in a transcription request. + // Describes the Amazon S3 location of the media file you want to use in your + // request. // // Media is a required field Media *Media `type:"structure" required:"true"` - // The audio format of the input media file. + // Specify the format of your input media file. MediaFormat *string `type:"string" enum:"MediaFormat"` - // The sample rate, in Hertz, of the audio track in the input media file. + // The sample rate, in Hertz, of the audio track in your input media file. // - // If you do not specify the media sample rate, Amazon Transcribe Medical determines - // the sample rate. If you specify the sample rate, it must match the rate detected - // by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz - // field blank and let Amazon Transcribe Medical determine the sample rate. + // If you don't specify the media sample rate, Amazon Transcribe Medical determines + // it for you. If you specify the sample rate, it must match the rate detected + // by Amazon Transcribe Medical; if there's a mismatch between the value you + // specify and the value detected, your job fails. Therefore, in most cases, + // it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical + // determine the sample rate. MediaSampleRateHertz *int64 `min:"16000" type:"integer"` - // The name of the medical transcription job. You can't use the strings "." - // or ".." by themselves as the job name. The name must also be unique within - // an Amazon Web Services account. If you try to create a medical transcription - // job with the same name as a previous medical transcription job, you get a - // ConflictException error. + // A unique name, chosen by you, for your medical transcription job. The name + // you specify is also used as the default name of your transcription output + // file. If you want to specify a different name for your transcription output, + // use the OutputKey parameter. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // MedicalTranscriptionJobName is a required field MedicalTranscriptionJobName *string `min:"1" type:"string" required:"true"` - // The Amazon S3 location where the transcription is stored. + // The name of the Amazon S3 bucket where you want your medical transcription + // output stored. Do not include the S3:// prefix of the specified bucket. + // + // If you want your output to go to a sub-folder of this bucket, specify it + // using the OutputKey parameter; OutputBucketName only accepts the name of + // a bucket. + // + // For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set + // OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output + // stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET + // and OutputKey to test-files/. // - // You must set OutputBucketName for Amazon Transcribe Medical to store the - // transcription results. Your transcript appears in the S3 location you specify. - // When you call the GetMedicalTranscriptionJob, the operation returns this - // location in the TranscriptFileUri field. The S3 bucket must have permissions - // that allow Amazon Transcribe Medical to put files in the bucket. For more - // information, see Permissions Required for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). + // Note that Amazon Transcribe must have permission to use the specified location. + // You can change Amazon S3 permissions using the Amazon Web Services Management + // Console (https://console.aws.amazon.com/s3). See also Permissions Required + // for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). // - // You can specify an Amazon Web Services Key Management Service (KMS) key to - // encrypt the output of your transcription using the OutputEncryptionKMSKeyId - // parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses - // the default Amazon S3 key for server-side encryption of transcripts that - // are placed in your S3 bucket. + // If you don't specify OutputBucketName, your transcript is placed in a service-managed + // Amazon S3 bucket and you are provided with a URI to access your transcript. // // OutputBucketName is a required field OutputBucketName *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the Amazon Web Services Key Management - // Service (KMS) key used to encrypt the output of the transcription job. The - // user calling the StartMedicalTranscriptionJob operation must have permission - // to use the specified KMS key. + // The KMS key you want to use to encrypt your medical transcription output. // - // You use either of the following to identify a KMS key in the current account: + // If using a key located in the current Amazon Web Services account, you can + // specify your KMS key in one of four ways: // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. // - // * KMS Key Alias: "alias/ExampleAlias" + // Use an alias for the KMS key ID. For example, alias/ExampleAlias. // - // You can use either of the following to identify a KMS key in the current - // account or another account: + // Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. // - // * Amazon Resource Name (ARN) of a KMS key in the current account or another - // account: "arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. // - // * ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias" + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one + // of two ways: // - // If you don't specify an encryption key, the output of the medical transcription - // job is encrypted with the default Amazon S3 key (SSE-S3). + // Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. + // + // Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. + // + // If you don't specify an encryption key, your output is encrypted with the + // default Amazon S3 key (SSE-S3). // // If you specify a KMS key to encrypt your output, you must also specify an - // output location in the OutputBucketName parameter. + // output location using the OutputLocation parameter. + // + // Note that the user making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string `min:"1" type:"string"` - // You can specify a location in an Amazon S3 bucket to store the output of - // your medical transcription job. + // Use in combination with OutputBucketName to specify the output location of + // your transcript and, optionally, a unique name for your output file. The + // default name for your transcription output is the same as the name you specified + // for your medical transcription job (MedicalTranscriptionJobName). // - // If you don't specify an output key, Amazon Transcribe Medical stores the - // output of your transcription job in the Amazon S3 bucket you specified. By - // default, the object key is "your-transcription-job-name.json". + // Here are some examples of how you can use OutputKey: // - // You can use output keys to specify the Amazon S3 prefix and file name of - // the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", - // as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". - // If you specify "my-other-job-name.json" as the output key, the object key - // is changed to "my-other-job-name.json". You can use an output key to change - // both the prefix and the file name, for example "folder/my-other-job-name.json". + // * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' + // as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json. // - // If you specify an output key, you must also specify an S3 bucket in the OutputBucketName - // parameter. + // * If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the + // OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. + // + // * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' + // as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. + // + // * If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' + // as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. + // + // If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, + // one is created for you. OutputKey *string `min:"1" type:"string"` - // Optional settings for the medical transcription job. + // Specify additional optional settings in your request, including channel identification, + // alternative transcriptions, and speaker labeling; allows you to apply custom + // vocabularies to your transcription job. Settings *MedicalTranscriptionSetting `type:"structure"` - // The medical specialty of any clinician speaking in the input media. + // Specify the predominant medical specialty represented in your media. For + // batch transcriptions, PRIMARYCARE is the only valid value. If you require + // additional specialties, refer to . // // Specialty is a required field Specialty *string `type:"string" required:"true" enum:"Specialty"` - // Add tags to an Amazon Transcribe Medical transcription job. + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new medical transcription job at the time you start this new job. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` - // The type of speech in the input audio. CONVERSATION refers to conversations - // between two or more speakers, e.g., a conversations between doctors and patients. - // DICTATION refers to single-speaker dictated speech, such as clinical notes. + // Specify whether your input media contains only one person (DICTATION) or + // contains a conversation between two people (CONVERSATION). + // + // For example, DICTATION could be used for a medical professional wanting to + // transcribe voice memos; CONVERSATION could be used for transcribing the doctor-patient + // dialogue during the patient's office visit. // // Type is a required field Type *string `type:"string" required:"true" enum:"Type"` @@ -10590,7 +11356,8 @@ func (s *StartMedicalTranscriptionJobInput) SetType(v string) *StartMedicalTrans type StartMedicalTranscriptionJobOutput struct { _ struct{} `type:"structure"` - // A batch job submitted to transcribe medical speech to text. + // Provides detailed information about the current medical transcription job, + // including job status and, if applicable, failure reason. MedicalTranscriptionJob *MedicalTranscriptionJob `type:"structure"` } @@ -10621,146 +11388,251 @@ func (s *StartMedicalTranscriptionJobOutput) SetMedicalTranscriptionJob(v *Medic type StartTranscriptionJobInput struct { _ struct{} `type:"structure"` - // An object that contains the request parameters for content redaction. + // Allows you to redact or flag specified personally identifiable information + // (PII) in your transcript. If you use ContentRedaction, you must also include + // the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType. ContentRedaction *ContentRedaction `type:"structure"` - // Set this field to true to enable automatic language identification. Automatic - // language identification is disabled by default. You receive a BadRequestException - // error if you enter a value for a LanguageCode. + // Enables automatic language identification in your transcription job request. + // + // If you include IdentifyLanguage, you can optionally include a list of language + // codes, using LanguageOptions, that you think may be present in your media + // file. Including language options can improve transcription accuracy. + // + // If you want to apply a custom language model, a custom vocabulary, or a custom + // vocabulary filter to your automatic language identification request, include + // LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, + // and VocabularyFilterName). // - // You must include either LanguageCode or IdentifyLanguage in your request. + // Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages + // in your request. If you include more than one of these parameters, your transcription + // job fails. IdentifyLanguage *bool `type:"boolean"` - // Provides information about how a transcription job is executed. Use this - // field to indicate that the job can be queued for deferred execution if the - // concurrency limit is reached and there are no slots available to immediately - // run the job. + // Enables automatic multi-language identification in your transcription job + // request. Use this parameter if your media file contains more than one language. + // + // If you include IdentifyMultipleLanguages, you can optionally include a list + // of language codes, using LanguageOptions, that you think may be present in + // your media file. Including language options can improve transcription accuracy. + // + // If you want to apply a custom vocabulary or a custom vocabulary filter to + // your automatic language identification request, include LanguageIdSettings + // with the relevant sub-parameters (VocabularyName and VocabularyFilterName). + // + // Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages + // in your request. If you include more than one of these parameters, your transcription + // job fails. + IdentifyMultipleLanguages *bool `type:"boolean"` + + // Allows you to control how your transcription job is processed. Currently, + // the only JobExecutionSettings modification you can choose is enabling job + // queueing using the AllowDeferredExecution sub-parameter. + // + // If you include JobExecutionSettings in your request, you must also include + // the sub-parameters: AllowDeferredExecution and DataAccessRoleArn. JobExecutionSettings *JobExecutionSettings `type:"structure"` // A map of plain text, non-secret key:value pairs, known as encryption context - // pairs, that provide an added layer of security for your data. + // pairs, that provide an added layer of security for your data. For more information, + // see KMS encryption context (https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) + // and Asymmetric keys in KMS (https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html). KMSEncryptionContext map[string]*string `min:"1" type:"map"` - // The language code for the language used in the input media file. You must - // include either LanguageCode or IdentifyLanguage in your request. + // The language code that represents the language spoken in the input media + // file. + // + // If you're unsure of the language spoken in your media file, consider using + // IdentifyLanguage or IdentifyMultipleLanguages to enable automatic language + // identification. + // + // Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages + // in your request. If you include more than one of these parameters, your transcription + // job fails. // - // To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video - // file must be encoded at a sample rate of 16,000 Hz or higher. + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. + // + // To transcribe speech in Modern Standard Arabic (ar-SA), your media file must + // be encoded at a sample rate of 16,000 Hz or higher. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The language identification settings associated with your transcription job. - // These settings include VocabularyName, VocabularyFilterName, and LanguageModelName. + // If using automatic language identification (IdentifyLanguage) in your request + // and you want to apply a custom language model, a custom vocabulary, or a + // custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters + // (VocabularyName, LanguageModelName, and VocabularyFilterName). + // + // You can specify two or more language codes that represent the languages you + // think may be present in your media; including more than five is not recommended. + // Each language code you include can have an associated custom language model, + // custom vocabulary, and custom vocabulary filter. The languages you specify + // must match the languages of the specified custom language models, custom + // vocabularies, and custom vocabulary filters. + // + // To include language options using IdentifyLanguage without including a custom + // language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions + // instead of LanguageIdSettings. Including language options can improve the + // accuracy of automatic language identification. + // + // If you want to include a custom language model with your request but do not + // want to use automatic language identification, use instead the parameter + // with the LanguageModelName sub-parameter. + // + // If you want to include a custom vocabulary or a custom vocabulary filter + // (or both) with your request but do not want to use automatic language identification, + // use instead the parameter with the VocabularyName or VocabularyFilterName + // (or both) sub-parameter. LanguageIdSettings map[string]*LanguageIdSettings `min:"1" type:"map"` - // An object containing a list of languages that might be present in your collection - // of audio files. Automatic language identification chooses a language that - // best matches the source audio from that list. + // You can specify two or more language codes that represent the languages you + // think may be present in your media; including more than five is not recommended. + // If you're unsure what languages are present, do not include this parameter. + // + // If you include LanguageOptions in your request, you must also include IdentifyLanguage. + // + // For more information, refer to Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html). // - // To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video - // file must be encoded at a sample rate of 16,000 Hz or higher. + // To transcribe speech in Modern Standard Arabic (ar-SA), your media file must + // be encoded at a sample rate of 16,000 Hz or higher. LanguageOptions []*string `min:"1" type:"list" enum:"LanguageCode"` - // An object that describes the input media for a transcription job. + // Describes the Amazon S3 location of the media file you want to use in your + // request. // // Media is a required field Media *Media `type:"structure" required:"true"` - // The format of the input media file. + // Specify the format of your input media file. MediaFormat *string `type:"string" enum:"MediaFormat"` - // The sample rate, in Hertz, of the audio track in the input media file. + // The sample rate, in Hertz, of the audio track in your input media file. // - // If you do not specify the media sample rate, Amazon Transcribe determines - // the sample rate. If you specify the sample rate, it must match the sample - // rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz - // field blank and let Amazon Transcribe determine the sample rate. + // If you don't specify the media sample rate, Amazon Transcribe determines + // it for you. If you specify the sample rate, it must match the rate detected + // by Amazon Transcribe; if there's a mismatch between the value you specify + // and the value detected, your job fails. Therefore, in most cases, it's advised + // to omit MediaSampleRateHertz and let Amazon Transcribe determine the sample + // rate. MediaSampleRateHertz *int64 `min:"8000" type:"integer"` - // Choose the custom language model you use for your transcription job in this - // parameter. + // Specify the custom language model you want to include with your transcription + // job. If you include ModelSettings in your request, you must include the LanguageModelName + // sub-parameter. + // + // For more information, see Custom language models (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). ModelSettings *ModelSettings `type:"structure"` - // The location where the transcription is stored. + // The name of the Amazon S3 bucket where you want your transcription output + // stored. Do not include the S3:// prefix of the specified bucket. // - // If you set the OutputBucketName, Amazon Transcribe puts the transcript in - // the specified S3 bucket. When you call the GetTranscriptionJob operation, - // the operation returns this location in the TranscriptFileUri field. If you - // enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. - // If you enable content redaction and choose to output an unredacted transcript, - // that transcript's location still appears in the TranscriptFileUri. The S3 - // bucket must have permissions that allow Amazon Transcribe to put files in - // the bucket. For more information, see Permissions Required for IAM User Roles - // (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). + // If you want your output to go to a sub-folder of this bucket, specify it + // using the OutputKey parameter; OutputBucketName only accepts the name of + // a bucket. // - // You can specify an Amazon Web Services Key Management Service (KMS) key to - // encrypt the output of your transcription using the OutputEncryptionKMSKeyId - // parameter. If you don't specify a KMS key, Amazon Transcribe uses the default - // Amazon S3 key for server-side encryption of transcripts that are placed in - // your S3 bucket. + // For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set + // OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output + // stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET + // and OutputKey to test-files/. // - // If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed - // URL, a shareable URL that provides secure access to your transcription, and - // returns it in the TranscriptFileUri field. Use this URL to download the transcription. + // Note that Amazon Transcribe must have permission to use the specified location. + // You can change Amazon S3 permissions using the Amazon Web Services Management + // Console (https://console.aws.amazon.com/s3). See also Permissions Required + // for IAM User Roles (https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user). + // + // If you don't specify OutputBucketName, your transcript is placed in a service-managed + // Amazon S3 bucket and you are provided with a URI to access your transcript. OutputBucketName *string `type:"string"` - // The Amazon Resource Name (ARN) of the Amazon Web Services Key Management - // Service (KMS) key used to encrypt the output of the transcription job. The - // user calling the StartTranscriptionJob operation must have permission to - // use the specified KMS key. + // The KMS key you want to use to encrypt your transcription output. + // + // If using a key located in the current Amazon Web Services account, you can + // specify your KMS key in one of four ways: // - // You can use either of the following to identify a KMS key in the current - // account: + // Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. // - // * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" + // Use an alias for the KMS key ID. For example, alias/ExampleAlias. // - // * KMS Key Alias: "alias/ExampleAlias" + // Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. // - // You can use either of the following to identify a KMS key in the current - // account or another account: + // Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. // - // * Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account - // ID:key/1234abcd-12ab-34cd-56ef-1234567890ab" + // If using a key located in a different Amazon Web Services account than the + // current Amazon Web Services account, you can specify your KMS key in one + // of two ways: // - // * ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias" + // Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. // - // If you don't specify an encryption key, the output of the transcription job - // is encrypted with the default Amazon S3 key (SSE-S3). + // Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. + // + // If you don't specify an encryption key, your output is encrypted with the + // default Amazon S3 key (SSE-S3). // // If you specify a KMS key to encrypt your output, you must also specify an - // output location in the OutputBucketName parameter. + // output location using the OutputLocation parameter. + // + // Note that the user making the request must have permission to use the specified + // KMS key. OutputEncryptionKMSKeyId *string `min:"1" type:"string"` - // You can specify a location in an Amazon S3 bucket to store the output of - // your transcription job. + // Use in combination with OutputBucketName to specify the output location of + // your transcript and, optionally, a unique name for your output file. The + // default name for your transcription output is the same as the name you specified + // for your transcription job (TranscriptionJobName). // - // If you don't specify an output key, Amazon Transcribe stores the output of - // your transcription job in the Amazon S3 bucket you specified. By default, - // the object key is "your-transcription-job-name.json". + // Here are some examples of how you can use OutputKey: // - // You can use output keys to specify the Amazon S3 prefix and file name of - // the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", - // as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". - // If you specify "my-other-job-name.json" as the output key, the object key - // is changed to "my-other-job-name.json". You can use an output key to change - // both the prefix and the file name, for example "folder/my-other-job-name.json". + // * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' + // as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json. // - // If you specify an output key, you must also specify an S3 bucket in the OutputBucketName - // parameter. + // * If you specify 'my-first-transcription' as the TranscriptionJobName, + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the + // OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. + // + // * If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' + // as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. + // + // * If you specify 'my-first-transcription' as the TranscriptionJobName, + // 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' + // as the OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. + // + // If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, + // one is created for you. OutputKey *string `min:"1" type:"string"` - // A Settings object that provides optional settings for a transcription job. + // Specify additional optional settings in your request, including channel identification, + // alternative transcriptions, speaker labeling; allows you to apply custom + // vocabularies and vocabulary filters. + // + // If you want to include a custom vocabulary or a custom vocabulary filter + // (or both) with your request but do not want to use automatic language identification, + // use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. + // + // If you're using automatic language identification with your request and want + // to include a custom language model, a custom vocabulary, or a custom vocabulary + // filter, use instead the parameter with the LanguageModelName, VocabularyName + // or VocabularyFilterName sub-parameters. Settings *Settings `type:"structure"` - // Add subtitles to your batch transcription job. + // Produces subtitle files for your input media. You can specify WebVTT (*.vtt) + // and SubRip (*.srt) formats. Subtitles *Subtitles `type:"structure"` - // Add tags to an Amazon Transcribe transcription job. + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new transcription job at the time you start this new job. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` - // The name of the job. You can't use the strings "." or ".." by themselves - // as the job name. The name must also be unique within an Amazon Web Services - // account. If you try to create a transcription job with the same name as a - // previous transcription job, you get a ConflictException error. + // A unique name, chosen by you, for your transcription job. The name you specify + // is also used as the default name of your transcription output file. If you + // want to specify a different name for your transcription output, use the OutputKey + // parameter. + // + // This name is case sensitive, cannot contain spaces, and must be unique within + // an Amazon Web Services account. If you try to create a new job with the same + // name as an existing job, you get a ConflictException error. // // TranscriptionJobName is a required field TranscriptionJobName *string `min:"1" type:"string" required:"true"` @@ -10881,6 +11753,12 @@ func (s *StartTranscriptionJobInput) SetIdentifyLanguage(v bool) *StartTranscrip return s } +// SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value. +func (s *StartTranscriptionJobInput) SetIdentifyMultipleLanguages(v bool) *StartTranscriptionJobInput { + s.IdentifyMultipleLanguages = &v + return s +} + // SetJobExecutionSettings sets the JobExecutionSettings field's value. func (s *StartTranscriptionJobInput) SetJobExecutionSettings(v *JobExecutionSettings) *StartTranscriptionJobInput { s.JobExecutionSettings = v @@ -10980,7 +11858,8 @@ func (s *StartTranscriptionJobInput) SetTranscriptionJobName(v string) *StartTra type StartTranscriptionJobOutput struct { _ struct{} `type:"structure"` - // Provides information about your asynchronous transcription job. + // Provides detailed information about the current transcription job, including + // job status and, if applicable, failure reason. TranscriptionJob *TranscriptionJob `type:"structure"` } @@ -11008,16 +11887,21 @@ func (s *StartTranscriptionJobOutput) SetTranscriptionJob(v *TranscriptionJob) * return s } -// Generate subtitles for your batch transcription job. Note that your subtitle -// files are placed in the same location as your transcription output. +// Generate subtitles for your media file with your transcription request. +// +// You can choose a start index of 0 or 1, and you can specify either WebVTT +// or SubRip (or both) as your output format. +// +// Note that your subtitle files are placed in the same location as your transcription +// output. type Subtitles struct { _ struct{} `type:"structure"` - // Specify the output format for your subtitle file; if you select both srt - // and vtt formats, two output files are generated. + // Specify the output format for your subtitle file; if you select both WebVTT + // (vtt) and SubRip (srt) formats, two output files are generated. Formats []*string `type:"list" enum:"SubtitleFormat"` - // Defines the starting value that is assigned to the first subtitle segment. + // Specify the starting value that is assigned to the first subtitle segment. // // The default start index for Amazon Transcribe is 0, which differs from the // more widely used standard of 1. If you're uncertain which value to use, we @@ -11055,22 +11939,36 @@ func (s *Subtitles) SetOutputStartIndex(v int64) *Subtitles { return s } -// The S3 location where your subtitle files are located. Note that your subtitle -// files are placed in the same location as your transcription output. Refer -// to TranscriptFileUri to download your files. +// Provides information about your subtitle file, including format, start index, +// and Amazon S3 location. type SubtitlesOutput_ struct { _ struct{} `type:"structure"` - // The format of your subtitle files. If your request specified both srt and - // vtt formats, both formats are shown. + // Provides the format of your subtitle files. If your request included both + // WebVTT (vtt) and SubRip (srt) formats, both formats are shown. Formats []*string `type:"list" enum:"SubtitleFormat"` - // Shows the output start index value for your subtitle files. If you did not - // specify a value in your request, the default value of 0 is used. + // Provides the start index value for your subtitle files. If you did not specify + // a value in your request, the default value of 0 is used. OutputStartIndex *int64 `type:"integer"` - // Contains the output location for your subtitle file. This location must be - // an S3 bucket. + // The Amazon S3 location of your transcript. You can use this URI to access + // or download your subtitle file. Your subtitle file is stored in the same + // location as your transcript. If you specified both WebVTT and SubRip subtitle + // formats, two URIs are provided. + // + // If you included OutputBucketName in your transcription job request, this + // is the URI of that bucket. If you also included OutputKey in your request, + // your output is located in the path you specified in your request. + // + // If you didn't include OutputBucketName in your transcription job request, + // your subtitle file is stored in a service-managed bucket, and TranscriptFileUri + // provides you with a temporary URI you can use for secure access to your subtitle + // file. + // + // Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 + // minutes. If you get an AccesDenied error, you can get a new temporary URI + // by running a GetTranscriptionJob or ListTranscriptionJob request. SubtitleFileUris []*string `type:"list"` } @@ -11110,22 +12008,28 @@ func (s *SubtitlesOutput_) SetSubtitleFileUris(v []*string) *SubtitlesOutput_ { return s } -// A key:value pair that adds metadata to a resource used by Amazon Transcribe. -// For example, a tag with the key:value pair ‘Department’:’Sales’ might -// be added to a resource to indicate its use by your organization's sales department. +// Adds metadata, in the form of a key:value pair, to the specified resource. +// +// For example, you could add the tag Department:Sales to a resource to indicate +// that it pertains to your organization's sales department. You can also use +// tags for tag-based access control. +// +// To learn more about tagging, see Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). type Tag struct { _ struct{} `type:"structure"` // The first part of a key:value pair that forms a tag associated with a given - // resource. For example, in the tag ‘Department’:’Sales’, the key is - // 'Department'. + // resource. For example, in the tag Department:Sales, the key is 'Department'. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The second part of a key:value pair that forms a tag associated with a given - // resource. For example, in the tag ‘Department’:’Sales’, the value - // is 'Sales'. + // resource. For example, in the tag Department:Sales, the value is 'Sales'. + // + // Note that you can set the value of a tag to an empty string, but you can't + // set the value of a tag to null. Omitting the tag value is the same as using + // an empty string. // // Value is a required field Value *string `type:"string" required:"true"` @@ -11183,16 +12087,22 @@ func (s *Tag) SetValue(v string) *Tag { type TagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want - // to tag. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id - // (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). + // The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have + // the format arn:partition:service:region:account-id:resource-type/resource-id. + // + // For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name. + // // Valid values for resource-type are: transcription-job, medical-transcription-job, // vocabulary, medical-vocabulary, vocabulary-filter, and language-model. // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` - // The tags you are assigning to a given Amazon Transcribe resource. + // Adds one or more custom tags, each in the form of a key:value pair, to the + // specified resource. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). // // Tags is a required field Tags []*Tag `min:"1" type:"list" required:"true"` @@ -11282,24 +12192,40 @@ func (s TagResourceOutput) GoString() string { return s.String() } -// Identifies the location of a transcription. +// Provides you with the Amazon S3 URI you can use to access your transcript. type Transcript struct { _ struct{} `type:"structure"` - // The S3 object location of the redacted transcript. + // The Amazon S3 location of your redacted transcript. You can use this URI + // to access or download your transcript. + // + // If you included OutputBucketName in your transcription job request, this + // is the URI of that bucket. If you also included OutputKey in your request, + // your output is located in the path you specified in your request. + // + // If you didn't include OutputBucketName in your transcription job request, + // your transcript is stored in a service-managed bucket, and RedactedTranscriptFileUri + // provides you with a temporary URI you can use for secure access to your transcript. // - // Use this URI to access the redacted transcript. If you specified an S3 bucket - // in the OutputBucketName field when you created the job, this is the URI of - // that bucket. If you chose to store the transcript in Amazon Transcribe, this - // is a shareable URL that provides secure access to that location. + // Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 + // minutes. If you get an AccesDenied error, you can get a new temporary URI + // by running a GetTranscriptionJob or ListTranscriptionJob request. RedactedTranscriptFileUri *string `min:"1" type:"string"` - // The S3 object location of the transcript. + // The Amazon S3 location of your transcript. You can use this URI to access + // or download your transcript. + // + // If you included OutputBucketName in your transcription job request, this + // is the URI of that bucket. If you also included OutputKey in your request, + // your output is located in the path you specified in your request. + // + // If you didn't include OutputBucketName in your transcription job request, + // your transcript is stored in a service-managed bucket, and TranscriptFileUri + // provides you with a temporary URI you can use for secure access to your transcript. // - // Use this URI to access the transcript. If you specified an S3 bucket in the - // OutputBucketName field when you created the job, this is the URI of that - // bucket. If you chose to store the transcript in Amazon Transcribe, this is - // a shareable URL that provides secure access to that location. + // Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 + // minutes. If you get an AccesDenied error, you can get a new temporary URI + // by running a GetTranscriptionJob or ListTranscriptionJob request. TranscriptFileUri *string `min:"1" type:"string"` } @@ -11333,38 +12259,52 @@ func (s *Transcript) SetTranscriptFileUri(v string) *Transcript { return s } -// Matches the output of the transcription to either the specific phrases that -// you specify, or the intent of the phrases that you specify. +// Flag the presence or absence of specific words or phrases detected in your +// Call Analytics transcription output. +// +// Rules using TranscriptFilter are designed to match: +// +// * Custom words or phrases spoken by the agent, the customer, or both +// +// * Custom words or phrases not spoken by the agent, the customer, or either +// +// * Custom words or phrases that occur at a specific time frame +// +// See Rule criteria (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules) +// for examples. type TranscriptFilter struct { _ struct{} `type:"structure"` - // A time range, set in seconds, between two points in the call. + // Allows you to specify a time range (in milliseconds) in your audio, during + // which you want to search for the specified key words or phrases. See for + // more detail. AbsoluteTimeRange *AbsoluteTimeRange `type:"structure"` - // If TRUE, the rule that you specify is applied to everything except for the - // phrases that you specify. + // Set to TRUE to flag the absence of the phrase you specified in your request. + // Set to FALSE to flag the presence of the phrase you specified in your request. Negate *bool `type:"boolean"` - // Determines whether the customer or the agent is speaking the phrases that - // you've specified. + // Specify the participant you want to flag. Omitting this parameter is equivalent + // to specifying both participants. ParticipantRole *string `type:"string" enum:"ParticipantRole"` - // An object that allows percentages to specify the proportion of the call where - // you would like to apply a filter. For example, you can specify the first - // half of the call. You can also specify the period of time between halfway - // through to three-quarters of the way through the call. Because the length - // of conversation can vary between calls, you can apply relative time ranges - // across all calls. + // Allows you to specify a time range (in percentage) in your media file, during + // which you want to search for the specified key words or phrases. See for + // more detail. RelativeTimeRange *RelativeTimeRange `type:"structure"` - // The phrases that you're specifying for the transcript filter to match. + // Specify the phrases you want to flag. // // Targets is a required field Targets []*string `min:"1" type:"list" required:"true"` - // Matches the phrase to the transcription output in a word for word fashion. - // For example, if you specify the phrase "I want to speak to the manager." - // Amazon Transcribe attempts to match that specific phrase to the transcription. + // Flag the presence or absence of an exact match to the phrases you specify. + // For example, if you specify the phrase "speak to a manager" as your Targets + // value, only that exact phrase is flagged. + // + // Note that semantic matching is not supported. For example, if your customer + // says "speak to the manager", instead of "speak to a manager", your content + // is not flagged. // // TranscriptFilterType is a required field TranscriptFilterType *string `type:"string" required:"true" enum:"TranscriptFilterType"` @@ -11443,113 +12383,204 @@ func (s *TranscriptFilter) SetTranscriptFilterType(v string) *TranscriptFilter { return s } -// Describes an asynchronous transcription job that was created with the StartTranscriptionJob -// operation. +// Provides detailed information about a transcription job. +// +// To view the status of the specified transcription job, check the TranscriptionJobStatus +// field. If the status is COMPLETED, the job is finished and you can find the +// results at the location specified in TranscriptFileUri. If the status is +// FAILED, FailureReason provides details on why your transcription job failed. +// +// If you enabled content redaction, the redacted transcript can be found at +// the location specified in RedactedTranscriptFileUri. type TranscriptionJob struct { _ struct{} `type:"structure"` - // A timestamp that shows when the job completed. + // The date and time the specified transcription job finished processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started + // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time `type:"timestamp"` - // An object that describes content redaction settings for the transcription - // job. + // Redacts or flags specified personally identifiable information (PII) in your + // transcript. ContentRedaction *ContentRedaction `type:"structure"` - // A timestamp that shows when the job was created. + // The date and time the specified transcription job request was made. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time `type:"timestamp"` - // If the TranscriptionJobStatus field is FAILED, this field contains information - // about why the job failed. + // If TranscriptionJobStatus is FAILED, FailureReason contains information about + // why the transcription job request failed. // - // The FailureReason field can contain one of the following values: + // The FailureReason field contains one of the following values: // - // * Unsupported media format - The media format specified in the MediaFormat - // field of the request isn't valid. See the description of the MediaFormat - // field for a list of valid values. + // * Unsupported media format. The media format specified in MediaFormat + // isn't valid. Refer to MediaFormat for a list of supported formats. // - // * The media format provided does not match the detected media format - - // The media format of the audio file doesn't match the format specified - // in the MediaFormat field in the request. Check the media format of your - // media file and make sure that the two values match. + // * The media format provided does not match the detected media format. + // The media format specified in MediaFormat doesn't match the format of + // the input file. Check the media format of your media file and correct + // the specified value. // - // * Invalid sample rate for audio file - The sample rate specified in the - // MediaSampleRateHertz of the request isn't valid. The sample rate must - // be between 8,000 and 48,000 Hertz. + // * Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz + // isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. // - // * The sample rate provided does not match the detected sample rate - The - // sample rate in the audio file doesn't match the sample rate specified - // in the MediaSampleRateHertz field in the request. Check the sample rate - // of your media file and make sure that the two values match. + // * The sample rate provided does not match the detected sample rate. The + // sample rate specified in MediaSampleRateHertz doesn't match the sample + // rate detected in your input media file. Check the sample rate of your + // media file and correct the specified value. // - // * Invalid file size: file size too large - The size of your audio file - // is larger than Amazon Transcribe can process. For more information, see - // Limits (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits) - // in the Amazon Transcribe Developer Guide. + // * Invalid file size: file size too large. The size of your media file + // is larger than what Amazon Transcribe can process. For more information, + // refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). // - // * Invalid number of channels: number of channels too large - Your audio - // contains more channels than Amazon Transcribe is configured to process. - // To request additional channels, see Amazon Transcribe Limits (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits-amazon-transcribe) - // in the Amazon Web Services General Reference. + // * Invalid number of channels: number of channels too large. Your audio + // contains more channels than Amazon Transcribe is able to process. For + // more information, refer to Guidelines and quotas (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits). FailureReason *string `type:"string"` - // A value between zero and one that Amazon Transcribe assigned to the language - // that it identified in the source audio. Larger values indicate that Amazon - // Transcribe has higher confidence in the language it identified. + // The confidence score associated with the language identified in your media + // file. + // + // Confidence scores are values between 0 and 1; a larger value indicates a + // higher probability that the identified language correctly matches the language + // spoken in your media. IdentifiedLanguageScore *float64 `type:"float"` - // A value that shows if automatic language identification was enabled for a - // transcription job. + // Indicates whether automatic language identification was enabled (TRUE) for + // the specified transcription job. IdentifyLanguage *bool `type:"boolean"` - // Provides information about how a transcription job is executed. + // Indicates whether automatic multi-language identification was enabled (TRUE) + // for the specified transcription job. + IdentifyMultipleLanguages *bool `type:"boolean"` + + // Provides information about how your transcription job is being processed. + // This parameter shows if your request is queued and what data access role + // is being used. JobExecutionSettings *JobExecutionSettings `type:"structure"` - // The language code for the input speech. + // The language code used to create your transcription job. For a list of supported + // languages and their associated language codes, refer to the Supported languages + // (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. + // + // Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages + // in your request. If you include more than one of these parameters, your transcription + // job fails. LanguageCode *string `type:"string" enum:"LanguageCode"` - // Language-specific settings that can be specified when language identification - // is enabled for your transcription job. These settings include VocabularyName, - // VocabularyFilterName, and LanguageModelName. + // The language codes used to create your transcription job. This parameter + // is used with multi-language identification. For single-language identification + // requests, refer to the singular version of this parameter, LanguageCode. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. + LanguageCodes []*LanguageCodeItem `type:"list"` + + // If using automatic language identification (IdentifyLanguage) in your request + // and you want to apply a custom language model, a custom vocabulary, or a + // custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters + // (VocabularyName, LanguageModelName, and VocabularyFilterName). + // + // You can specify two or more language codes that represent the languages you + // think may be present in your media; including more than five is not recommended. + // Each language code you include can have an associated custom language model, + // custom vocabulary, and custom vocabulary filter. The languages you specify + // must match the languages of the specified custom language models, custom + // vocabularies, and custom vocabulary filters. + // + // To include language options using IdentifyLanguage without including a custom + // language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions + // instead of LanguageIdSettings. Including language options can improve the + // accuracy of automatic language identification. + // + // If you want to include a custom language model with your request but do not + // want to use automatic language identification, use instead the parameter + // with the LanguageModelName sub-parameter. + // + // If you want to include a custom vocabulary or a custom vocabulary filter + // (or both) with your request but do not want to use automatic language identification, + // use instead the parameter with the VocabularyName or VocabularyFilterName + // (or both) sub-parameter. LanguageIdSettings map[string]*LanguageIdSettings `min:"1" type:"map"` - // An object that shows the optional array of languages inputted for transcription - // jobs with automatic language identification enabled. + // You can specify two or more language codes that represent the languages you + // think may be present in your media; including more than five is not recommended. + // If you're unsure what languages are present, do not include this parameter. + // + // If you include LanguageOptions in your request, you must also include IdentifyLanguage. + // + // For more information, refer to Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html). + // + // To transcribe speech in Modern Standard Arabic (ar-SA), your media file must + // be encoded at a sample rate of 16,000 Hz or higher. LanguageOptions []*string `min:"1" type:"list" enum:"LanguageCode"` - // An object that describes the input media for the transcription job. + // Describes the Amazon S3 location of the media file you want to use in your + // request. Media *Media `type:"structure"` // The format of the input media file. MediaFormat *string `type:"string" enum:"MediaFormat"` - // The sample rate, in Hertz (Hz), of the audio track in the input media file. + // The sample rate, in Hertz, of the audio track in your input media file. MediaSampleRateHertz *int64 `min:"8000" type:"integer"` - // An object containing the details of your custom language model. + // The custom language model you want to include with your transcription job. + // If you include ModelSettings in your request, you must include the LanguageModelName + // sub-parameter. ModelSettings *ModelSettings `type:"structure"` - // Optional settings for the transcription job. Use these settings to turn on - // speaker recognition, to set the maximum number of speakers that should be - // identified and to specify a custom vocabulary to use when processing the - // transcription job. + // Specify additional optional settings in your request, including channel identification, + // alternative transcriptions, speaker labeling; allows you to apply custom + // vocabularies and vocabulary filters. + // + // If you want to include a custom vocabulary or a custom vocabulary filter + // (or both) with your request but do not want to use automatic language identification, + // use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. + // + // If you're using automatic language identification with your request and want + // to include a custom language model, a custom vocabulary, or a custom vocabulary + // filter, do not use the Settings parameter; use instead the parameter with + // the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters. Settings *Settings `type:"structure"` - // A timestamp that shows when the job started processing. + // The date and time the specified transcription job began processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time `type:"timestamp"` - // Generate subtitles for your batch transcription job. + // Generate subtitles for your media file with your transcription request. Subtitles *SubtitlesOutput_ `type:"structure"` - // A key:value pair assigned to a given transcription job. + // Adds one or more custom tags, each in the form of a key:value pair, to a + // new transcription job at the time you start this new job. + // + // To learn more about using tags with Amazon Transcribe, refer to Tagging resources + // (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html). Tags []*Tag `min:"1" type:"list"` - // An object that describes the output of the transcription job. + // Provides you with the Amazon S3 URI you can use to access your transcript. Transcript *Transcript `type:"structure"` - // The name of the transcription job. + // The name of the transcription job. Job names are case sensitive and must + // be unique within an Amazon Web Services account. TranscriptionJobName *string `min:"1" type:"string"` - // The status of the transcription job. + // Provides the status of the specified transcription job. + // + // If the status is COMPLETED, the job is finished and you can find the results + // at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, + // if you requested transcript redaction). If the status is FAILED, FailureReason + // provides details on why your transcription job failed. TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"` } @@ -11607,6 +12638,12 @@ func (s *TranscriptionJob) SetIdentifyLanguage(v bool) *TranscriptionJob { return s } +// SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value. +func (s *TranscriptionJob) SetIdentifyMultipleLanguages(v bool) *TranscriptionJob { + s.IdentifyMultipleLanguages = &v + return s +} + // SetJobExecutionSettings sets the JobExecutionSettings field's value. func (s *TranscriptionJob) SetJobExecutionSettings(v *JobExecutionSettings) *TranscriptionJob { s.JobExecutionSettings = v @@ -11619,6 +12656,12 @@ func (s *TranscriptionJob) SetLanguageCode(v string) *TranscriptionJob { return s } +// SetLanguageCodes sets the LanguageCodes field's value. +func (s *TranscriptionJob) SetLanguageCodes(v []*LanguageCodeItem) *TranscriptionJob { + s.LanguageCodes = v + return s +} + // SetLanguageIdSettings sets the LanguageIdSettings field's value. func (s *TranscriptionJob) SetLanguageIdSettings(v map[string]*LanguageIdSettings) *TranscriptionJob { s.LanguageIdSettings = v @@ -11697,57 +12740,92 @@ func (s *TranscriptionJob) SetTranscriptionJobStatus(v string) *TranscriptionJob return s } -// Provides a summary of information about a transcription job. +// Provides detailed information about a specific transcription job. type TranscriptionJobSummary struct { _ struct{} `type:"structure"` - // A timestamp that shows when the job was completed. + // The date and time the specified transcription job finished processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started + // processing at 12:33 PM UTC-7 on May 4, 2022. CompletionTime *time.Time `type:"timestamp"` // The content redaction settings of the transcription job. ContentRedaction *ContentRedaction `type:"structure"` - // A timestamp that shows when the job was created. + // The date and time the specified transcription job request was made. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. CreationTime *time.Time `type:"timestamp"` - // If the TranscriptionJobStatus field is FAILED, a description of the error. + // If TranscriptionJobStatus is FAILED, FailureReason contains information about + // why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html). FailureReason *string `type:"string"` - // A value between zero and one that Amazon Transcribe assigned to the language - // it identified in the source audio. A higher score indicates that Amazon Transcribe - // is more confident in the language it identified. + // The confidence score associated with the language identified in your media + // file. + // + // Confidence scores are values between 0 and 1; a larger value indicates a + // higher probability that the identified language correctly matches the language + // spoken in your media. IdentifiedLanguageScore *float64 `type:"float"` - // Whether automatic language identification was enabled for a transcription - // job. + // Indicates whether automatic language identification was enabled (TRUE) for + // the specified transcription job. IdentifyLanguage *bool `type:"boolean"` - // The language code for the input speech. + // Indicates whether automatic multi-language identification was enabled (TRUE) + // for the specified transcription job. + IdentifyMultipleLanguages *bool `type:"boolean"` + + // The language code used to create your transcription. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The object used to call your custom language model to your transcription - // job. + // The language codes used to create your transcription job. This parameter + // is used with multi-language identification. For single-language identification, + // the singular version of this parameter, LanguageCode, is present. + LanguageCodes []*LanguageCodeItem `type:"list"` + + // Provides the name of the custom language model that was included in the specified + // transcription job. + // + // Only use ModelSettings with the LanguageModelName sub-parameter if you're + // not using automatic language identification (). If using LanguageIdSettings + // in your request, this parameter contains a LanguageModelName sub-parameter. ModelSettings *ModelSettings `type:"structure"` - // Indicates the location of the output of the transcription job. + // Indicates where the specified transcription output is stored. // - // If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified - // in the outputBucketName field when the transcription job was started with - // the StartTranscriptionJob operation. + // If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you + // specified using the OutputBucketName parameter in your request. If you also + // included OutputKey in your request, your output is located in the path you + // specified in your request. // - // If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe - // and can be retrieved using the URI in the GetTranscriptionJob response's - // TranscriptFileUri field. + // If the value is SERVICE_BUCKET, the location is a service-managed Amazon + // S3 bucket. To access a transcript stored in a service-managed bucket, use + // the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field. OutputLocationType *string `type:"string" enum:"OutputLocationType"` - // A timestamp that shows when the job started processing. + // The date and time your transcription job began processing. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started + // processing at 12:32 PM UTC-7 on May 4, 2022. StartTime *time.Time `type:"timestamp"` - // The name of the transcription job. + // The name of the transcription job. Job names are case sensitive and must + // be unique within an Amazon Web Services account. TranscriptionJobName *string `min:"1" type:"string"` - // The status of the transcription job. When the status is COMPLETED, use the - // GetTranscriptionJob operation to get the results of the transcription. + // Provides the status of your transcription job. + // + // If the status is COMPLETED, the job is finished and you can find the results + // at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, + // if you requested transcript redaction). If the status is FAILED, FailureReason + // provides details on why your transcription job failed. TranscriptionJobStatus *string `type:"string" enum:"TranscriptionJobStatus"` } @@ -11805,12 +12883,24 @@ func (s *TranscriptionJobSummary) SetIdentifyLanguage(v bool) *TranscriptionJobS return s } +// SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value. +func (s *TranscriptionJobSummary) SetIdentifyMultipleLanguages(v bool) *TranscriptionJobSummary { + s.IdentifyMultipleLanguages = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *TranscriptionJobSummary) SetLanguageCode(v string) *TranscriptionJobSummary { s.LanguageCode = &v return s } +// SetLanguageCodes sets the LanguageCodes field's value. +func (s *TranscriptionJobSummary) SetLanguageCodes(v []*LanguageCodeItem) *TranscriptionJobSummary { + s.LanguageCodes = v + return s +} + // SetModelSettings sets the ModelSettings field's value. func (s *TranscriptionJobSummary) SetModelSettings(v *ModelSettings) *TranscriptionJobSummary { s.ModelSettings = v @@ -11845,16 +12935,17 @@ type UntagResourceInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want - // to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id - // (for example, arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). + // to remove tags from. ARNs have the format arn:partition:service:region:account-id:resource-type/resource-id. + // + // For example, arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name. + // // Valid values for resource-type are: transcription-job, medical-transcription-job, // vocabulary, medical-vocabulary, vocabulary-filter, and language-model. // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` - // A list of tag keys you want to remove from a specified Amazon Transcribe - // resource. + // Removes the specified tag keys from the specified Amazon Transcribe resource. // // TagKeys is a required field TagKeys []*string `min:"1" type:"list" required:"true"` @@ -11937,15 +13028,15 @@ func (s UntagResourceOutput) GoString() string { type UpdateCallAnalyticsCategoryInput struct { _ struct{} `type:"structure"` - // The name of the analytics category to update. The name is case sensitive. - // If you try to update a call analytics category with the same name as a previous - // category you will receive a ConflictException error. + // The name of the Call Analytics category you want to update. Category names + // are case sensitive. // // CategoryName is a required field CategoryName *string `min:"1" type:"string" required:"true"` - // The rules used for the updated analytics category. The rules that you provide - // in this field replace the ones that are currently being used. + // The rules used for the updated Call Analytics category. The rules you provide + // in this field replace the ones that are currently being used in the specified + // category. // // Rules is a required field Rules []*Rule `min:"1" type:"list" required:"true"` @@ -12016,9 +13107,8 @@ func (s *UpdateCallAnalyticsCategoryInput) SetRules(v []*Rule) *UpdateCallAnalyt type UpdateCallAnalyticsCategoryOutput struct { _ struct{} `type:"structure"` - // The attributes describing the analytics category. You can see information - // such as the rules that you've used to update the category and when the category - // was originally created. + // Provides you with the properties of the Call Analytics category you specified + // in your UpdateCallAnalyticsCategory request. CategoryProperties *CategoryProperties `type:"structure"` } @@ -12049,33 +13139,22 @@ func (s *UpdateCallAnalyticsCategoryOutput) SetCategoryProperties(v *CategoryPro type UpdateMedicalVocabularyInput struct { _ struct{} `type:"structure"` - // The language code of the language used for the entries in the updated vocabulary. - // U.S. English (en-US) is the only valid language code in Amazon Transcribe - // Medical. + // The language code that represents the language of the entries in the custom + // vocabulary you want to update. US English (en-US) is the only language supported + // with Amazon Transcribe Medical. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // The location in Amazon S3 of the text file that contains your custom vocabulary. - // The URI must be in the same Amazon Web Services Region as the resource that - // you are calling. The following is the format for a URI: - // - // https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey - // - // For example: - // - // https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt + // The Amazon S3 location of the text file that contains your custom medical + // vocabulary. The URI must be located in the same Amazon Web Services Region + // as the resource you're calling. // - // For more information about Amazon S3 object names, see Object Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys) - // in the Amazon S3 Developer Guide. - // - // For more information about custom vocabularies in Amazon Transcribe Medical, - // see Medical Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html). + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt VocabularyFileUri *string `min:"1" type:"string"` - // The name of the vocabulary to update. The name is case sensitive. If you - // try to update a vocabulary with the same name as a vocabulary you've already - // made, you get a ConflictException error. + // The name of the custom medical vocabulary you want to update. Vocabulary + // names are case sensitive. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -12142,20 +13221,21 @@ func (s *UpdateMedicalVocabularyInput) SetVocabularyName(v string) *UpdateMedica type UpdateMedicalVocabularyOutput struct { _ struct{} `type:"structure"` - // The language code for the language of the text file used to update the custom - // vocabulary. US English (en-US) is the only language supported in Amazon Transcribe - // Medical. + // The language code you selected for your medical vocabulary. US English (en-US) + // is the only language supported with Amazon Transcribe Medical. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary was updated. + // The date and time the specified custom medical vocabulary was last updated. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the updated vocabulary. + // The name of the updated custom medical vocabulary. VocabularyName *string `min:"1" type:"string"` - // The processing state of the update to the vocabulary. When the VocabularyState - // field is READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob - // request. + // The processing state of your custom medical vocabulary. If the state is READY, + // you can use the vocabulary in a StartMedicalTranscriptionJob request. VocabularyState *string `type:"string" enum:"VocabularyState"` } @@ -12204,30 +13284,35 @@ func (s *UpdateMedicalVocabularyOutput) SetVocabularyState(v string) *UpdateMedi type UpdateVocabularyFilterInput struct { _ struct{} `type:"structure"` - // The Amazon S3 location of a text file used as input to create the vocabulary - // filter. Only use characters from the character set defined for custom vocabularies. - // For a list of character sets, see Character Sets for Custom Vocabularies - // (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html). + // The Amazon S3 location of the text file that contains your custom vocabulary + // filter terms. The URI must be located in the same Amazon Web Services Region + // as the resource you're calling. // - // The specified file must be less than 50 KB of UTF-8 characters. + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt // - // If you provide the location of a list of words in the VocabularyFilterFileUri - // parameter, you can't use the Words parameter. + // Note that if you include VocabularyFilterFileUri in your request, you cannot + // use Words; you must choose one or the other. VocabularyFilterFileUri *string `min:"1" type:"string"` - // The name of the vocabulary filter to update. If you try to update a vocabulary - // filter with the same name as another vocabulary filter, you get a ConflictException - // error. + // The name of the custom vocabulary filter you want to update. Vocabulary filter + // names are case sensitive. // // VocabularyFilterName is a required field VocabularyFilterName *string `min:"1" type:"string" required:"true"` - // The words to use in the vocabulary filter. Only use characters from the character - // set defined for custom vocabularies. For a list of character sets, see Character - // Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html). + // Use this parameter if you want to update your vocabulary filter by including + // all desired terms, as comma-separated values, within your request. The other + // option for updating your vocabulary filter is to save your entries in a text + // file and upload them to an Amazon S3 bucket, then specify the location of + // your file using the VocabularyFilterFileUri parameter. + // + // Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; + // you must choose one or the other. // - // If you provide a list of words in the Words parameter, you can't use the - // VocabularyFilterFileUri parameter. + // Each language has a character set that contains all allowed characters for + // that specific language. If you use unsupported characters, your vocabulary + // filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) + // to get the character set for your language. Words []*string `min:"1" type:"list"` } @@ -12292,13 +13377,16 @@ func (s *UpdateVocabularyFilterInput) SetWords(v []*string) *UpdateVocabularyFil type UpdateVocabularyFilterOutput struct { _ struct{} `type:"structure"` - // The language code of the words in the vocabulary filter. + // The language code you selected for your vocabulary filter. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary filter was updated. + // The date and time the specified vocabulary filter was last updated. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the updated vocabulary filter. + // The name of the updated custom vocabulary filter. VocabularyFilterName *string `min:"1" type:"string"` } @@ -12341,34 +13429,49 @@ func (s *UpdateVocabularyFilterOutput) SetVocabularyFilterName(v string) *Update type UpdateVocabularyInput struct { _ struct{} `type:"structure"` - // The language code of the vocabulary entries. For a list of languages and - // their corresponding language codes, see Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html). + // The language code that represents the language of the entries in the custom + // vocabulary you want to update. Each vocabulary must contain terms in only + // one language. + // + // A custom vocabulary can only be used to transcribe files in the same language + // as the vocabulary. For example, if you create a vocabulary using US English + // (en-US), you can only apply this vocabulary to files that contain English + // audio. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // An array of strings containing the vocabulary entries. - Phrases []*string `type:"list"` - - // The S3 location of the text file that contains the definition of the custom - // vocabulary. The URI must be in the same region as the API endpoint that you - // are calling. The general form is: - // - // https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey + // Use this parameter if you want to update your vocabulary by including all + // desired terms, as comma-separated values, within your request. The other + // option for updating your vocabulary is to save your entries in a text file + // and upload them to an Amazon S3 bucket, then specify the location of your + // file using the VocabularyFileUri parameter. // - // For example: + // Note that if you include Phrases in your request, you cannot use VocabularyFileUri; + // you must choose one or the other. // - // https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt + // Each language has a character set that contains all allowed characters for + // that specific language. If you use unsupported characters, your vocabulary + // filter request fails. Refer to Character Sets for Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html) + // to get the character set for your language. + Phrases []*string `type:"list"` + + // The Amazon S3 location of the text file that contains your custom vocabulary. + // The URI must be located in the same Amazon Web Services Region as the resource + // you're calling. // - // For more information about S3 object names, see Object Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys) - // in the Amazon S3 Developer Guide. + // Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt // - // For more information about custom vocabularies, see Custom Vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). + // Note that if you include VocabularyFileUri in your request, you cannot use + // the Phrases flag; you must choose one or the other. VocabularyFileUri *string `min:"1" type:"string"` - // The name of the vocabulary to update. The name is case sensitive. If you - // try to update a vocabulary with the same name as a previous vocabulary you - // will receive a ConflictException error. + // The name of the custom vocabulary you want to update. Vocabulary names are + // case sensitive. // // VocabularyName is a required field VocabularyName *string `min:"1" type:"string" required:"true"` @@ -12441,17 +13544,20 @@ func (s *UpdateVocabularyInput) SetVocabularyName(v string) *UpdateVocabularyInp type UpdateVocabularyOutput struct { _ struct{} `type:"structure"` - // The language code of the vocabulary entries. + // The language code you selected for your custom vocabulary. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary was updated. + // The date and time the specified vocabulary was last updated. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary that was updated. + // The name of the updated custom vocabulary. VocabularyName *string `min:"1" type:"string"` - // The processing state of the vocabulary. When the VocabularyState field contains - // READY the vocabulary is ready to be used in a StartTranscriptionJob request. + // The processing state of your custom vocabulary. If the state is READY, you + // can use the vocabulary in a StartTranscriptionJob request. VocabularyState *string `type:"string" enum:"VocabularyState"` } @@ -12497,18 +13603,32 @@ func (s *UpdateVocabularyOutput) SetVocabularyState(v string) *UpdateVocabularyO return s } -// Provides information about a vocabulary filter. +// Provides information about a vocabulary filter, including the language of +// the filter, when it was last modified, and its name. type VocabularyFilterInfo struct { _ struct{} `type:"structure"` - // The language code of the words in the vocabulary filter. + // The language code that represents the language of the entries in your vocabulary + // filter. Each vocabulary filter must contain terms in only one language. + // + // A vocabulary filter can only be used to transcribe files in the same language + // as the filter. For example, if you create a vocabulary filter using US English + // (en-US), you can only apply this filter to files that contain English audio. + // + // For a list of supported languages and their associated language codes, refer + // to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) + // table. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary was last updated. + // The date and time the specified vocabulary filter was last modified. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary filter. The name must be unique in the account - // that holds the filter. + // A unique name, chosen by you, for your custom vocabulary filter. This name + // is case sensitive, cannot contain spaces, and must be unique within an Amazon + // Web Services account. VocabularyFilterName *string `min:"1" type:"string"` } @@ -12548,21 +13668,33 @@ func (s *VocabularyFilterInfo) SetVocabularyFilterName(v string) *VocabularyFilt return s } -// Provides information about a custom vocabulary. +// Provides information about a custom vocabulary, including the language of +// the vocabulary, when it was last modified, its name, and the processing state. type VocabularyInfo struct { _ struct{} `type:"structure"` - // The language code of the vocabulary entries. + // The language code used to create your custom vocabulary. Each vocabulary + // must contain terms in only one language. + // + // A custom vocabulary can only be used to transcribe files in the same language + // as the vocabulary. For example, if you create a vocabulary using US English + // (en-US), you can only apply this vocabulary to files that contain English + // audio. LanguageCode *string `type:"string" enum:"LanguageCode"` - // The date and time that the vocabulary was last modified. + // The date and time the specified vocabulary was last modified. + // + // Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, + // 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022. LastModifiedTime *time.Time `type:"timestamp"` - // The name of the vocabulary. + // A unique name, chosen by you, for your custom vocabulary. This name is case + // sensitive, cannot contain spaces, and must be unique within an Amazon Web + // Services account. VocabularyName *string `min:"1" type:"string"` - // The processing state of the vocabulary. If the state is READY you can use - // the vocabulary in a StartTranscriptionJob request. + // The processing state of your custom vocabulary. If the state is READY, you + // can use the vocabulary in a StartTranscriptionJob request. VocabularyState *string `type:"string" enum:"VocabularyState"` } diff --git a/service/transcribeservice/doc.go b/service/transcribeservice/doc.go index 13d898ee2e7..29dc9c351ea 100644 --- a/service/transcribeservice/doc.go +++ b/service/transcribeservice/doc.go @@ -3,7 +3,18 @@ // Package transcribeservice provides the client and types for making API // requests to Amazon Transcribe Service. // -// Operations and objects for transcribing speech to text. +// Amazon Transcribe offers three main types of batch transcription: Standard, +// Medical, and Call Analytics. +// +// * Standard transcriptions are the most common option. Refer to for details. +// +// * Medical transcriptions are tailored to medical professionals and incorporate +// medical terms. A common use case for this service is transcribing doctor-patient +// dialogue into after-visit notes. Refer to for details. +// +// * Call Analytics transcriptions are designed for use with call center +// audio on two different channels; if you're looking for insight into customer +// service calls, use this option. Refer to for details. // // See https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26 for more information on this service. // diff --git a/service/transcribeservice/errors.go b/service/transcribeservice/errors.go index 306a541cd6e..8cfc67f7229 100644 --- a/service/transcribeservice/errors.go +++ b/service/transcribeservice/errors.go @@ -11,37 +11,38 @@ const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". // - // Your request didn't pass one or more validation tests. For example, if the - // entity that you're trying to delete doesn't exist or if it is in a non-terminal - // state (for example, it's "in progress"). See the exception Message field - // for more information. + // Your request didn't pass one or more validation tests. This can occur when + // the entity you're trying to delete doesn't exist or if it's in a non-terminal + // state (such as IN PROGRESS). See the exception message field for more information. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code // "ConflictException". // - // There is already a resource with that name. + // A resource already exists with this name. Resource names must be unique within + // an Amazon Web Services account. ErrCodeConflictException = "ConflictException" // ErrCodeInternalFailureException for service response error code // "InternalFailureException". // - // There was an internal error. Check the error message and try your request - // again. + // There was an internal error. Check the error message, correct the issue, + // and try your request again. ErrCodeInternalFailureException = "InternalFailureException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // - // Either you have sent too many requests or your input file is too long. Wait - // before you resend your request, or use a smaller file and resend the request. + // You've either sent too many requests or your input file is too long. Wait + // before retrying your request, or use a smaller file and try your request + // again. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // - // We can't find the requested resource. Check the name and try your request - // again. + // We can't find the requested resource. Check that the specified name is correct + // and try your request again. ErrCodeNotFoundException = "NotFoundException" )