Skip to content

Commit aa5d9f0

Browse files
author
awstools
committed
docs(client-transcribe): Update documentation to use key ARN only in OutputEncryptionKMSKeyId request parameter
1 parent 0c9e1b8 commit aa5d9f0

File tree

2 files changed

+43
-169
lines changed

2 files changed

+43
-169
lines changed

‎clients/client-transcribe/src/models/models_0.ts

Lines changed: 39 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -4964,49 +4964,17 @@ export interface StartCallAnalyticsJobRequest {
49644964
OutputLocation?: string | undefined;
49654965

49664966
/**
4967-
* <p>The KMS key you want to use to encrypt your Call Analytics
4968-
* output.</p>
4969-
* <p>If using a key located in the <b>current</b>
4970-
* Amazon Web Services account, you can specify your KMS key in one of four
4971-
* ways:</p>
4972-
* <ol>
4973-
* <li>
4974-
* <p>Use the KMS key ID itself. For example,
4975-
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
4976-
* </li>
4977-
* <li>
4978-
* <p>Use an alias for the KMS key ID. For example,
4979-
* <code>alias/ExampleAlias</code>.</p>
4980-
* </li>
4981-
* <li>
4982-
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
4983-
* example,
4984-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
4985-
* </li>
4986-
* <li>
4987-
* <p>Use the ARN for the KMS key alias. For example,
4988-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
4989-
* </li>
4990-
* </ol>
4991-
* <p>If using a key located in a <b>different</b>
4992-
* Amazon Web Services account than the current Amazon Web Services account, you can specify
4993-
* your KMS key in one of two ways:</p>
4994-
* <ol>
4995-
* <li>
4996-
* <p>Use the ARN for the KMS key ID. For example,
4997-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
4998-
* </li>
4999-
* <li>
5000-
* <p>Use the ARN for the KMS key alias. For example,
5001-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5002-
* </li>
5003-
* </ol>
4967+
* <p>The Amazon Resource Name (ARN) of a KMS key that you want to use to
4968+
* encrypt your Call Analytics output.</p>
4969+
* <p>KMS key ARNs have the format <code>arn:partition:kms:region:account:key/key-id</code>. For example:
4970+
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.
4971+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">
4972+
* KMS key ARNs</a>.</p>
50044973
* <p>If you do not specify an encryption key, your output is encrypted with the default
5005-
* Amazon S3 key (SSE-S3).</p>
5006-
* <p>If you specify a KMS key to encrypt your output, you must also specify
5007-
* an output location using the <code>OutputLocation</code> parameter.</p>
5008-
* <p>Note that the role making the request must
5009-
* have permission to use the specified KMS key.</p>
4974+
* Amazon S3 key (SSE-S3).</p>
4975+
* <p>Note that the role making the request and the role specified in
4976+
* the <code>DataAccessRoleArn</code> request parameter (if present) must have permission to use the
4977+
* specified KMS key.</p>
50104978
* @public
50114979
*/
50124980
OutputEncryptionKMSKeyId?: string | undefined;
@@ -5097,47 +5065,17 @@ export interface StartMedicalScribeJobRequest {
50975065
OutputBucketName: string | undefined;
50985066

50995067
/**
5100-
* <p>The KMS key you want to use to encrypt your Medical Scribe
5101-
* output.</p>
5102-
* <p>If using a key located in the <b>current</b>
5103-
* Amazon Web Services account, you can specify your KMS key in one of four
5104-
* ways:</p>
5105-
* <ol>
5106-
* <li>
5107-
* <p>Use the KMS key ID itself. For example,
5108-
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5109-
* </li>
5110-
* <li>
5111-
* <p>Use an alias for the KMS key ID. For example,
5112-
* <code>alias/ExampleAlias</code>.</p>
5113-
* </li>
5114-
* <li>
5115-
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
5116-
* example,
5117-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5118-
* </li>
5119-
* <li>
5120-
* <p>Use the ARN for the KMS key alias. For example,
5121-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5122-
* </li>
5123-
* </ol>
5124-
* <p>If using a key located in a <b>different</b>
5125-
* Amazon Web Services account than the current Amazon Web Services account, you can specify
5126-
* your KMS key in one of two ways:</p>
5127-
* <ol>
5128-
* <li>
5129-
* <p>Use the ARN for the KMS key ID. For example,
5130-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5131-
* </li>
5132-
* <li>
5133-
* <p>Use the ARN for the KMS key alias. For example,
5134-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5135-
* </li>
5136-
* </ol>
5068+
* <p>The Amazon Resource Name (ARN) of a KMS key that you want to use to
5069+
* encrypt your Medical Scribe output.</p>
5070+
* <p>KMS key ARNs have the format <code>arn:partition:kms:region:account:key/key-id</code>. For example:
5071+
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.
5072+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">
5073+
* KMS key ARNs</a>.</p>
51375074
* <p>If you do not specify an encryption key, your output is encrypted with the default
51385075
* Amazon S3 key (SSE-S3).</p>
5139-
* <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
5140-
* must have permission to use the specified KMS key.</p>
5076+
* <p>Note that the role making the request and the role specified in
5077+
* the <code>DataAccessRoleArn</code> request parameter (if present)
5078+
* must have permission to use the specified KMS key.</p>
51415079
* @public
51425080
*/
51435081
OutputEncryptionKMSKeyId?: string | undefined;
@@ -5320,49 +5258,17 @@ export interface StartMedicalTranscriptionJobRequest {
53205258
OutputKey?: string | undefined;
53215259

53225260
/**
5323-
* <p>The KMS key you want to use to encrypt your medical transcription
5324-
* output.</p>
5325-
* <p>If using a key located in the <b>current</b>
5326-
* Amazon Web Services account, you can specify your KMS key in one of four
5327-
* ways:</p>
5328-
* <ol>
5329-
* <li>
5330-
* <p>Use the KMS key ID itself. For example,
5331-
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5332-
* </li>
5333-
* <li>
5334-
* <p>Use an alias for the KMS key ID. For example,
5335-
* <code>alias/ExampleAlias</code>.</p>
5336-
* </li>
5337-
* <li>
5338-
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
5339-
* example,
5340-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5341-
* </li>
5342-
* <li>
5343-
* <p>Use the ARN for the KMS key alias. For example,
5344-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5345-
* </li>
5346-
* </ol>
5347-
* <p>If using a key located in a <b>different</b>
5348-
* Amazon Web Services account than the current Amazon Web Services account, you can specify
5349-
* your KMS key in one of two ways:</p>
5350-
* <ol>
5351-
* <li>
5352-
* <p>Use the ARN for the KMS key ID. For example,
5353-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5354-
* </li>
5355-
* <li>
5356-
* <p>Use the ARN for the KMS key alias. For example,
5357-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5358-
* </li>
5359-
* </ol>
5261+
* <p>The Amazon Resource Name (ARN) of a KMS key that you want to use to
5262+
* encrypt your medical transcription output.</p>
5263+
* <p>KMS key ARNs have the format <code>arn:partition:kms:region:account:key/key-id</code>. For example:
5264+
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.
5265+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">
5266+
* KMS key ARNs</a>.</p>
53605267
* <p>If you do not specify an encryption key, your output is encrypted with the default
5361-
* Amazon S3 key (SSE-S3).</p>
5362-
* <p>If you specify a KMS key to encrypt your output, you must also specify
5363-
* an output location using the <code>OutputLocation</code> parameter.</p>
5364-
* <p>Note that the role making the request must
5365-
* have permission to use the specified KMS key.</p>
5268+
* Amazon S3 key (SSE-S3).</p>
5269+
* <p>Note that the role making the request and the role specified
5270+
* in the <code>DataAccessRoleArn</code> request parameter (if present) must have permission to use the
5271+
* specified KMS key.</p>
53665272
* @public
53675273
*/
53685274
OutputEncryptionKMSKeyId?: string | undefined;
@@ -5575,49 +5481,17 @@ export interface StartTranscriptionJobRequest {
55755481
OutputKey?: string | undefined;
55765482

55775483
/**
5578-
* <p>The KMS key you want to use to encrypt your transcription
5579-
* output.</p>
5580-
* <p>If using a key located in the <b>current</b>
5581-
* Amazon Web Services account, you can specify your KMS key in one of four
5582-
* ways:</p>
5583-
* <ol>
5584-
* <li>
5585-
* <p>Use the KMS key ID itself. For example,
5586-
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5587-
* </li>
5588-
* <li>
5589-
* <p>Use an alias for the KMS key ID. For example,
5590-
* <code>alias/ExampleAlias</code>.</p>
5591-
* </li>
5592-
* <li>
5593-
* <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
5594-
* example,
5595-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5596-
* </li>
5597-
* <li>
5598-
* <p>Use the ARN for the KMS key alias. For example,
5599-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5600-
* </li>
5601-
* </ol>
5602-
* <p>If using a key located in a <b>different</b>
5603-
* Amazon Web Services account than the current Amazon Web Services account, you can specify
5604-
* your KMS key in one of two ways:</p>
5605-
* <ol>
5606-
* <li>
5607-
* <p>Use the ARN for the KMS key ID. For example,
5608-
* <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
5609-
* </li>
5610-
* <li>
5611-
* <p>Use the ARN for the KMS key alias. For example,
5612-
* <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
5613-
* </li>
5614-
* </ol>
5484+
* <p>The Amazon Resource Name (ARN) of a KMS key that you want to use to
5485+
* encrypt your transcription output.</p>
5486+
* <p>KMS key ARNs have the format <code>arn:partition:kms:region:account:key/key-id</code>. For example:
5487+
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.
5488+
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">
5489+
* KMS key ARNs</a>.</p>
56155490
* <p>If you do not specify an encryption key, your output is encrypted with the default
5616-
* Amazon S3 key (SSE-S3).</p>
5617-
* <p>If you specify a KMS key to encrypt your output, you must also specify
5618-
* an output location using the <code>OutputLocation</code> parameter.</p>
5619-
* <p>Note that the role making the request must
5620-
* have permission to use the specified KMS key.</p>
5491+
* Amazon S3 key (SSE-S3).</p>
5492+
* <p>Note that the role making the request and the role specified in the
5493+
* <code>DataAccessRoleArn</code> request parameter (if present) must have permission to use the specified
5494+
* KMS key.</p>
56215495
* @public
56225496
*/
56235497
OutputEncryptionKMSKeyId?: string | undefined;

0 commit comments

Comments
 (0)