From ed7b888af9a2e6dfcc5c2210bd17bae801e98536 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 31 May 2024 18:25:58 +0000 Subject: [PATCH] feat(client-codeguru-security): This release includes minor model updates and documentation updates. --- clients/client-codeguru-security/README.md | 3 +- .../src/CodeGuruSecurity.ts | 3 +- .../src/CodeGuruSecurityClient.ts | 3 +- .../src/commands/BatchGetFindingsCommand.ts | 2 +- .../src/commands/CreateScanCommand.ts | 2 +- .../src/commands/CreateUploadUrlCommand.ts | 5 +- .../GetAccountConfigurationCommand.ts | 2 +- .../src/commands/GetMetricsSummaryCommand.ts | 2 +- .../src/commands/GetScanCommand.ts | 4 + .../src/commands/ListScansCommand.ts | 2 +- .../UpdateAccountConfigurationCommand.ts | 2 +- clients/client-codeguru-security/src/index.ts | 3 +- .../src/models/models_0.ts | 133 +++++++++-------- .../src/protocols/Aws_restJson1.ts | 1 + .../aws-models/codeguru-security.json | 134 ++++++++++-------- 15 files changed, 171 insertions(+), 130 deletions(-) diff --git a/clients/client-codeguru-security/README.md b/clients/client-codeguru-security/README.md index 8456865297ef..4b5f0547cb00 100644 --- a/clients/client-codeguru-security/README.md +++ b/clients/client-codeguru-security/README.md @@ -7,8 +7,7 @@ AWS SDK for JavaScript CodeGuruSecurity Client for Node.js, Browser and React Native. -

Amazon CodeGuru Security is in preview release and is subject to -change.

+

Amazon CodeGuru Security is in preview release and is subject to change.

This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect diff --git a/clients/client-codeguru-security/src/CodeGuruSecurity.ts b/clients/client-codeguru-security/src/CodeGuruSecurity.ts index 739bdea1698c..892858254e27 100644 --- a/clients/client-codeguru-security/src/CodeGuruSecurity.ts +++ b/clients/client-codeguru-security/src/CodeGuruSecurity.ts @@ -253,8 +253,7 @@ export interface CodeGuruSecurity { /** * - *

Amazon CodeGuru Security is in preview release and is subject to - * change.

+ *

Amazon CodeGuru Security is in preview release and is subject to change.

* *

This section provides documentation for the Amazon CodeGuru Security API operations. * CodeGuru Security is a service that uses program analysis and machine learning to detect diff --git a/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts b/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts index 0678d58e892b..c7999856777b 100644 --- a/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts +++ b/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts @@ -298,8 +298,7 @@ export interface CodeGuruSecurityClientResolvedConfig extends CodeGuruSecurityCl /** * - *

Amazon CodeGuru Security is in preview release and is subject to - * change.

+ *

Amazon CodeGuru Security is in preview release and is subject to change.

* *

This section provides documentation for the Amazon CodeGuru Security API operations. * CodeGuru Security is a service that uses program analysis and machine learning to detect diff --git a/clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts b/clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts index 4a859d2a7771..558a930c8935 100644 --- a/clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts +++ b/clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts @@ -27,7 +27,7 @@ export interface BatchGetFindingsCommandInput extends BatchGetFindingsRequest {} export interface BatchGetFindingsCommandOutput extends BatchGetFindingsResponse, __MetadataBearer {} /** - *

Returns a list of all requested findings.

+ *

Returns a list of requested findings from standard scans.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-codeguru-security/src/commands/CreateScanCommand.ts b/clients/client-codeguru-security/src/commands/CreateScanCommand.ts index b5107f396419..6dc1f6bfefb2 100644 --- a/clients/client-codeguru-security/src/commands/CreateScanCommand.ts +++ b/clients/client-codeguru-security/src/commands/CreateScanCommand.ts @@ -27,7 +27,7 @@ export interface CreateScanCommandInput extends CreateScanRequest {} export interface CreateScanCommandOutput extends CreateScanResponse, __MetadataBearer {} /** - *

Use to create a scan using code uploaded to an S3 bucket.

+ *

Use to create a scan using code uploaded to an Amazon S3 bucket.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-codeguru-security/src/commands/CreateUploadUrlCommand.ts b/clients/client-codeguru-security/src/commands/CreateUploadUrlCommand.ts index 5391fd445fbb..6049a7eb2d30 100644 --- a/clients/client-codeguru-security/src/commands/CreateUploadUrlCommand.ts +++ b/clients/client-codeguru-security/src/commands/CreateUploadUrlCommand.ts @@ -31,8 +31,9 @@ export interface CreateUploadUrlCommandInput extends CreateUploadUrlRequest {} export interface CreateUploadUrlCommandOutput extends CreateUploadUrlResponse, __MetadataBearer {} /** - *

Generates a pre-signed URL and request headers used to upload a code resource.

- *

You can upload your code resource to the URL and add the request headers using any HTTP + *

Generates a pre-signed URL, request headers used to upload a code resource, and code + * artifact identifier for the uploaded resource.

+ *

You can upload your code resource to the URL with the request headers using any HTTP * client.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts b/clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts index 0839af31759b..6aa521a70e0c 100644 --- a/clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts +++ b/clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts @@ -27,7 +27,7 @@ export interface GetAccountConfigurationCommandInput extends GetAccountConfigura export interface GetAccountConfigurationCommandOutput extends GetAccountConfigurationResponse, __MetadataBearer {} /** - *

Use to get account level configuration.

+ *

Use to get the encryption configuration for an account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-codeguru-security/src/commands/GetMetricsSummaryCommand.ts b/clients/client-codeguru-security/src/commands/GetMetricsSummaryCommand.ts index b683b889f9df..e2740128dad6 100644 --- a/clients/client-codeguru-security/src/commands/GetMetricsSummaryCommand.ts +++ b/clients/client-codeguru-security/src/commands/GetMetricsSummaryCommand.ts @@ -27,7 +27,7 @@ export interface GetMetricsSummaryCommandInput extends GetMetricsSummaryRequest export interface GetMetricsSummaryCommandOutput extends GetMetricsSummaryResponse, __MetadataBearer {} /** - *

Returns top level metrics about an account from a specified date, including number of open + *

Returns a summary of metrics for an account from a specified date, including number of open * findings, the categories with most findings, the scans with most open findings, and scans with * most open critical findings.

* @example diff --git a/clients/client-codeguru-security/src/commands/GetScanCommand.ts b/clients/client-codeguru-security/src/commands/GetScanCommand.ts index 31928b7b138a..bb5e8cf6e8e0 100644 --- a/clients/client-codeguru-security/src/commands/GetScanCommand.ts +++ b/clients/client-codeguru-security/src/commands/GetScanCommand.ts @@ -49,6 +49,7 @@ export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer * // updatedAt: new Date("TIMESTAMP"), * // numberOfRevisions: Number("long"), * // scanNameArn: "STRING_VALUE", + * // errorMessage: "STRING_VALUE", * // }; * * ``` @@ -71,6 +72,9 @@ export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling.

* + * @throws {@link ValidationException} (client fault) + *

The input fails to satisfy the specified constraints.

+ * * @throws {@link CodeGuruSecurityServiceException} *

Base exception class for all service exceptions from CodeGuruSecurity service.

* diff --git a/clients/client-codeguru-security/src/commands/ListScansCommand.ts b/clients/client-codeguru-security/src/commands/ListScansCommand.ts index 9edad9c5b035..9ca061b50545 100644 --- a/clients/client-codeguru-security/src/commands/ListScansCommand.ts +++ b/clients/client-codeguru-security/src/commands/ListScansCommand.ts @@ -27,7 +27,7 @@ export interface ListScansCommandInput extends ListScansRequest {} export interface ListScansCommandOutput extends ListScansResponse, __MetadataBearer {} /** - *

Returns a list of all the standard scans in an account. Does not return express + *

Returns a list of all scans in an account. Does not return EXPRESS * scans.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts b/clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts index 2814fd715aa4..ff7b76130807 100644 --- a/clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts +++ b/clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts @@ -27,7 +27,7 @@ export interface UpdateAccountConfigurationCommandInput extends UpdateAccountCon export interface UpdateAccountConfigurationCommandOutput extends UpdateAccountConfigurationResponse, __MetadataBearer {} /** - *

Use to update account-level configuration with an encryption key.

+ *

Use to update the encryption configuration for an account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-codeguru-security/src/index.ts b/clients/client-codeguru-security/src/index.ts index a9519bf4ed39..ddc7aa85e45c 100644 --- a/clients/client-codeguru-security/src/index.ts +++ b/clients/client-codeguru-security/src/index.ts @@ -2,8 +2,7 @@ /* eslint-disable */ /** * - *

Amazon CodeGuru Security is in preview release and is subject to - * change.

+ *

Amazon CodeGuru Security is in preview release and is subject to change.

* *

This section provides documentation for the Amazon CodeGuru Security API operations. * CodeGuru Security is a service that uses program analysis and machine learning to detect diff --git a/clients/client-codeguru-security/src/models/models_0.ts b/clients/client-codeguru-security/src/models/models_0.ts index 965339bbf027..6b05e7a6f302 100644 --- a/clients/client-codeguru-security/src/models/models_0.ts +++ b/clients/client-codeguru-security/src/models/models_0.ts @@ -45,73 +45,74 @@ export class AccessDeniedException extends __BaseException { } /** - *

The severity of the issue in the code that generated a finding.

+ *

A numeric value corresponding to the severity of a finding, such as the number of open + * findings or the average time it takes to close findings of a given severity.

* @public */ export interface FindingMetricsValuePerSeverity { /** - *

The finding is related to quality or readability improvements and not considered - * actionable.

+ *

A numeric value corresponding to an informational finding.

* @public */ info?: number; /** - *

The severity of the finding is low and does require action on its own.

+ *

A numeric value corresponding to a low severity finding.

* @public */ low?: number; /** - *

The severity of the finding is medium and should be addressed as a mid-term priority.

+ *

A numeric value corresponding to a medium severity finding.

* @public */ medium?: number; /** - *

The severity of the finding is high and should be addressed as a near-term priority.

+ *

A numeric value corresponding to a high severity finding.

* @public */ high?: number; /** - *

The severity of the finding is critical and should be addressed immediately.

+ *

A numeric value corresponding to a critical finding.

* @public */ critical?: number; } /** - *

A summary of findings metrics in an account.

+ *

A summary of findings metrics for an account on a specified date.

* @public */ export interface AccountFindingsMetric { /** - *

The date from which the finding metrics were retrieved.

+ *

The date from which the findings metrics were retrieved.

* @public */ date?: Date; /** - *

The number of new findings of each severity in account on the specified date.

+ *

The number of new findings of each severity on the specified date.

* @public */ newFindings?: FindingMetricsValuePerSeverity; /** - *

The number of closed findings of each severity in an account on the specified date.

+ *

The number of closed findings of each severity on the specified date.

* @public */ closedFindings?: FindingMetricsValuePerSeverity; /** - *

The number of open findings of each severity in an account as of the specified date.

+ *

The number of open findings of each severity as of the specified date.

* @public */ openFindings?: FindingMetricsValuePerSeverity; /** - *

The average time it takes to close findings of each severity in days.

+ *

The average time in days it takes to close findings of each severity as of a specified + * date.

* @public */ meanTimeToClose?: FindingMetricsValuePerSeverity; @@ -239,7 +240,7 @@ export interface SuggestedFix { description?: string; /** - *

The suggested code to add to your file.

+ *

The suggested code fix. If applicable, includes code patch to replace your source code.

* @public */ code?: string; @@ -265,19 +266,18 @@ export interface Remediation { } /** - *

Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that - * contains a finding.

+ *

Information about a resource that contains a finding.

* @public */ export interface Resource { /** - *

The identifier for the resource.

+ *

The scanName of the scan that was run on the resource.

* @public */ id?: string; /** - *

The identifier for a section of the resource, such as an AWS Lambda layer.

+ *

The identifier for a section of the resource.

* @public */ subResourceId?: string; @@ -403,7 +403,9 @@ export interface Vulnerability { filePath?: FilePath; /** - *

The number of times the vulnerability appears in your code.

+ * @deprecated + * + *

The number of times the vulnerability appears in your code.

* @public */ itemCount?: number; @@ -427,8 +429,7 @@ export interface Finding { description?: string; /** - *

The identifier for the component that generated a finding such as AWSCodeGuruSecurity or - * AWSInspector.

+ *

The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

* @public */ generatorId?: string; @@ -471,7 +472,10 @@ export interface Finding { vulnerability?: Vulnerability; /** - *

The severity of the finding.

+ *

The severity of the finding. Severity can be critical, high, medium, low, or + * informational. For information on severity levels, see + * Finding severity in the + * Amazon CodeGuru Security User Guide.

* @public */ severity?: Severity; @@ -521,7 +525,7 @@ export interface Finding { */ export interface BatchGetFindingsResponse { /** - *

A list of all requested findings.

+ *

A list of all findings which were successfully fetched.

* @public */ findings: Finding[] | undefined; @@ -727,7 +731,8 @@ export class ConflictException extends __BaseException { } /** - *

The identifier for a resource object that contains resources where a finding was detected.

+ *

The identifier for a resource object that contains resources to scan. Specifying a + * codeArtifactId is required to create a scan.

* @public */ export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMember; @@ -737,7 +742,8 @@ export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMe */ export namespace ResourceId { /** - *

The identifier for the code file uploaded to the resource where a finding was detected.

+ *

The identifier for the code file uploaded to the resource object. Returned by + * CreateUploadUrl when you upload resources to be scanned.

* @public */ export interface CodeArtifactIdMember { @@ -790,15 +796,14 @@ export interface CreateScanRequest { clientToken?: string; /** - *

The identifier for an input resource used to create a scan.

+ *

The identifier for the resource object to be scanned.

* @public */ resourceId: ResourceId | undefined; /** - *

The unique name that CodeGuru Security uses to track revisions across multiple - * scans of the same resource. Only allowed for a STANDARD scan type. If not - * specified, it will be auto generated.

+ *

The unique name that CodeGuru Security uses to track revisions across multiple scans of + * the same resource. Only allowed for a STANDARD scan type.

* @public */ scanName: string | undefined; @@ -952,7 +957,7 @@ export interface CreateUploadUrlRequest { */ export interface CreateUploadUrlResponse { /** - *

A pre-signed S3 URL. You can upload the code file you want to scan and add the required + *

A pre-signed S3 URL. You can upload the code file you want to scan with the required * requestHeaders using any HTTP client.

* @public */ @@ -966,7 +971,8 @@ export interface CreateUploadUrlResponse { requestHeaders: Record | undefined; /** - *

The identifier for the uploaded code resource.

+ *

The identifier for the uploaded code resource. Pass this to CreateScan to use + * the uploaded resources.

* @public */ codeArtifactId: string | undefined; @@ -978,13 +984,14 @@ export interface CreateUploadUrlResponse { export interface GetAccountConfigurationRequest {} /** - *

Information about account-level configuration.

+ *

Information about the encryption configuration for an account. Required to call + * UpdateAccountConfiguration.

* @public */ export interface EncryptionConfig { /** - *

The KMS key ARN to use for encryption. This must be provided as a header when uploading - * your code resource.

+ *

The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, + * returns empty.

* @public */ kmsKeyArn?: string; @@ -995,9 +1002,10 @@ export interface EncryptionConfig { */ export interface GetAccountConfigurationResponse { /** - *

An EncryptionConfig object that contains the KMS key ARN to use for + *

An EncryptionConfig object that contains the KMS key ARN that is used for * encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify - * your own key, call UpdateAccountConfiguration.

+ * your own key, call UpdateAccountConfiguration. If you do not specify a + * customer-managed key, returns empty.

* @public */ encryptionConfig: EncryptionConfig | undefined; @@ -1025,7 +1033,7 @@ export interface GetFindingsRequest { *

The maximum number of results to return in the response. Use this parameter when * paginating results. If additional results exist beyond the number you specify, the nextToken * element is returned in the response. Use nextToken in a subsequent request to retrieve - * additional results.

+ * additional results. If not specified, returns 1000 results.

* @public */ maxResults?: number; @@ -1062,8 +1070,7 @@ export interface GetFindingsResponse { export interface GetMetricsSummaryRequest { /** *

The date you want to retrieve summary metrics from, rounded to the nearest day. The date - * must be within the past two years since metrics data is only stored for two years. If a date - * outside of this range is passed, the response will be empty.

+ * must be within the past two years.

* @public */ date: Date | undefined; @@ -1089,7 +1096,7 @@ export interface CategoryWithFindingNum { } /** - *

Information about a scan with open findings.

+ *

Information about the number of findings generated by a scan.

* @public */ export interface ScanNameWithFindingNum { @@ -1100,14 +1107,14 @@ export interface ScanNameWithFindingNum { scanName?: string; /** - *

The number of open findings generated by a scan.

+ *

The number of findings generated by a scan.

* @public */ findingNumber?: number; } /** - *

Information about summary metrics in an account.

+ *

A summary of metrics for an account as of a specified date.

* @public */ export interface MetricsSummary { @@ -1118,28 +1125,28 @@ export interface MetricsSummary { date?: Date; /** - *

The number of open findings of each severity in an account.

+ *

The number of open findings of each severity.

* @public */ openFindings?: FindingMetricsValuePerSeverity; /** *

A list of CategoryWithFindingNum objects for the top 5 finding categories - * with the most open findings in an account.

+ * with the most findings.

* @public */ categoriesWithMostFindings?: CategoryWithFindingNum[]; /** *

A list of ScanNameWithFindingNum objects for the top 3 scans with the most - * number of open critical findings in an account.

+ * number of open findings.

* @public */ scansWithMostOpenFindings?: ScanNameWithFindingNum[]; /** *

A list of ScanNameWithFindingNum objects for the top 3 scans with the most - * number of open findings in an account.

+ * number of open critical findings.

* @public */ scansWithMostOpenCriticalFindings?: ScanNameWithFindingNum[]; @@ -1191,7 +1198,7 @@ export interface GetScanResponse { runId: string | undefined; /** - *

The current state of the scan. Pass either InProgress, + *

The current state of the scan. Returns either InProgress, * Successful, or Failed.

* @public */ @@ -1229,6 +1236,12 @@ export interface GetScanResponse { * @public */ scanNameArn?: string; + + /** + *

Details about the error that causes a scan to fail to be retrieved.

+ * @public + */ + errorMessage?: string; } /** @@ -1248,19 +1261,21 @@ export interface ListFindingsMetricsRequest { *

The maximum number of results to return in the response. Use this parameter when * paginating results. If additional results exist beyond the number you specify, the nextToken * element is returned in the response. Use nextToken in a subsequent request to retrieve - * additional results.

+ * additional results. If not specified, returns 1000 results.

* @public */ maxResults?: number; /** - *

The start date of the interval which you want to retrieve metrics from.

+ *

The start date of the interval which you want to retrieve metrics from. Rounds to the + * nearest day.

* @public */ startDate: Date | undefined; /** - *

The end date of the interval which you want to retrieve metrics from.

+ *

The end date of the interval which you want to retrieve metrics from. Round to the nearest + * day.

* @public */ endDate: Date | undefined; @@ -1300,7 +1315,7 @@ export interface ListScansRequest { *

The maximum number of results to return in the response. Use this parameter when * paginating results. If additional results exist beyond the number you specify, the nextToken * element is returned in the response. Use nextToken in a subsequent request to retrieve - * additional results.

+ * additional results. If not specified, returns 100 results.

* @public */ maxResults?: number; @@ -1373,7 +1388,7 @@ export interface ListScansResponse { export interface ListTagsForResourceRequest { /** *

The ARN of the ScanName object. You can retrieve this ARN by calling - * ListScans or GetScan.

+ * CreateScan, ListScans, or GetScan.

* @public */ resourceArn: string | undefined; @@ -1408,7 +1423,7 @@ export interface ListTagsForResourceResponse { export interface TagResourceRequest { /** *

The ARN of the ScanName object. You can retrieve this ARN by calling - * ListScans or GetScan.

+ * CreateScan, ListScans, or GetScan.

* @public */ resourceArn: string | undefined; @@ -1443,7 +1458,7 @@ export interface TagResourceResponse {} export interface UntagResourceRequest { /** *

The ARN of the ScanName object. You can retrieve this ARN by calling - * ListScans or GetScan.

+ * CreateScan, ListScans, or GetScan.

* @public */ resourceArn: string | undefined; @@ -1465,7 +1480,10 @@ export interface UntagResourceResponse {} */ export interface UpdateAccountConfigurationRequest { /** - *

The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.

+ *

The customer-managed KMS key ARN you want to use for encryption. If not specified, + * CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a + * customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption + * instead, pass nothing.

* @public */ encryptionConfig: EncryptionConfig | undefined; @@ -1476,8 +1494,9 @@ export interface UpdateAccountConfigurationRequest { */ export interface UpdateAccountConfigurationResponse { /** - *

An EncryptionConfig object that contains the KMS key ARN to use for - * encryption.

+ *

An EncryptionConfig object that contains the KMS key ARN that is used for + * encryption. If you did not specify a customer-managed KMS key in the request, returns empty. + *

* @public */ encryptionConfig: EncryptionConfig | undefined; diff --git a/clients/client-codeguru-security/src/protocols/Aws_restJson1.ts b/clients/client-codeguru-security/src/protocols/Aws_restJson1.ts index 7d8e772bc063..9d7800d2da69 100644 --- a/clients/client-codeguru-security/src/protocols/Aws_restJson1.ts +++ b/clients/client-codeguru-security/src/protocols/Aws_restJson1.ts @@ -496,6 +496,7 @@ export const de_GetScanCommand = async ( const doc = take(data, { analysisType: __expectString, createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + errorMessage: __expectString, numberOfRevisions: __expectLong, runId: __expectString, scanName: __expectString, diff --git a/codegen/sdk-codegen/aws-models/codeguru-security.json b/codegen/sdk-codegen/aws-models/codeguru-security.json index df2b2719754e..8c1b421bda0b 100644 --- a/codegen/sdk-codegen/aws-models/codeguru-security.json +++ b/codegen/sdk-codegen/aws-models/codeguru-security.json @@ -43,36 +43,36 @@ "date": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date from which the finding metrics were retrieved.

" + "smithy.api#documentation": "

The date from which the findings metrics were retrieved.

" } }, "newFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of new findings of each severity in account on the specified date.

" + "smithy.api#documentation": "

The number of new findings of each severity on the specified date.

" } }, "closedFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of closed findings of each severity in an account on the specified date.

" + "smithy.api#documentation": "

The number of closed findings of each severity on the specified date.

" } }, "openFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of open findings of each severity in an account as of the specified date.

" + "smithy.api#documentation": "

The number of open findings of each severity as of the specified date.

" } }, "meanTimeToClose": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The average time it takes to close findings of each severity in days.

" + "smithy.api#documentation": "

The average time in days it takes to close findings of each severity as of a specified\n date.

" } } }, "traits": { - "smithy.api#documentation": "

A summary of findings metrics in an account.

" + "smithy.api#documentation": "

A summary of findings metrics for an account on a specified date.

" } }, "com.amazonaws.codegurusecurity#AnalysisType": { @@ -167,7 +167,7 @@ ], "origin": "*" }, - "smithy.api#documentation": "\n

Amazon CodeGuru Security is in preview release and is subject to\n change.

\n \n

This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.

\n

By proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.

", + "smithy.api#documentation": "\n

Amazon CodeGuru Security is in preview release and is subject to change.

\n \n

This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.

\n

By proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.

", "smithy.api#title": "Amazon CodeGuru Security", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -858,7 +858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all requested findings.

", + "smithy.api#documentation": "

Returns a list of requested findings from standard scans.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -930,7 +930,7 @@ "findings": { "target": "com.amazonaws.codegurusecurity#Findings", "traits": { - "smithy.api#documentation": "

A list of all requested findings.

", + "smithy.api#documentation": "

A list of all findings which were successfully fetched.

", "smithy.api#required": {} } }, @@ -1080,7 +1080,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use to create a scan using code uploaded to an S3 bucket.

", + "smithy.api#documentation": "

Use to create a scan using code uploaded to an Amazon S3 bucket.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1101,14 +1101,14 @@ "resourceId": { "target": "com.amazonaws.codegurusecurity#ResourceId", "traits": { - "smithy.api#documentation": "

The identifier for an input resource used to create a scan.

", + "smithy.api#documentation": "

The identifier for the resource object to be scanned.

", "smithy.api#required": {} } }, "scanName": { "target": "com.amazonaws.codegurusecurity#ScanName", "traits": { - "smithy.api#documentation": "

The unique name that CodeGuru Security uses to track revisions across multiple\n scans of the same resource. Only allowed for a STANDARD scan type. If not\n specified, it will be auto generated.

", + "smithy.api#documentation": "

The unique name that CodeGuru Security uses to track revisions across multiple scans of\n the same resource. Only allowed for a STANDARD scan type.

", "smithy.api#required": {} } }, @@ -1200,7 +1200,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a pre-signed URL and request headers used to upload a code resource.

\n

You can upload your code resource to the URL and add the request headers using any HTTP\n client.

", + "smithy.api#documentation": "

Generates a pre-signed URL, request headers used to upload a code resource, and code\n artifact identifier for the uploaded resource.

\n

You can upload your code resource to the URL with the request headers using any HTTP\n client.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1229,7 +1229,7 @@ "s3Url": { "target": "com.amazonaws.codegurusecurity#S3Url", "traits": { - "smithy.api#documentation": "

A pre-signed S3 URL. You can upload the code file you want to scan and add the required\n requestHeaders using any HTTP client.

", + "smithy.api#documentation": "

A pre-signed S3 URL. You can upload the code file you want to scan with the required\n requestHeaders using any HTTP client.

", "smithy.api#required": {} } }, @@ -1243,7 +1243,7 @@ "codeArtifactId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

The identifier for the uploaded code resource.

", + "smithy.api#documentation": "

The identifier for the uploaded code resource. Pass this to CreateScan to use\n the uploaded resources.

", "smithy.api#required": {} } } @@ -1264,12 +1264,12 @@ "kmsKeyArn": { "target": "com.amazonaws.codegurusecurity#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The KMS key ARN to use for encryption. This must be provided as a header when uploading\n your code resource.

" + "smithy.api#documentation": "

The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption,\n returns empty.

" } } }, "traits": { - "smithy.api#documentation": "

Information about account-level configuration.

" + "smithy.api#documentation": "

Information about the encryption configuration for an account. Required to call\n UpdateAccountConfiguration.

" } }, "com.amazonaws.codegurusecurity#ErrorCode": { @@ -1307,6 +1307,14 @@ } } }, + "com.amazonaws.codegurusecurity#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.codegurusecurity#FilePath": { "type": "structure", "members": { @@ -1363,7 +1371,7 @@ "generatorId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier for the component that generated a finding such as AWSCodeGuruSecurity or\n AWSInspector.

" + "smithy.api#documentation": "

The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

" } }, "id": { @@ -1405,7 +1413,7 @@ "severity": { "target": "com.amazonaws.codegurusecurity#Severity", "traits": { - "smithy.api#documentation": "

The severity of the finding.

" + "smithy.api#documentation": "

The severity of the finding. Severity can be critical, high, medium, low, or\n informational. For information on severity levels, see \n Finding severity in the \n Amazon CodeGuru Security User Guide.

" } }, "remediation": { @@ -1489,36 +1497,36 @@ "info": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The finding is related to quality or readability improvements and not considered\n actionable.

" + "smithy.api#documentation": "

A numeric value corresponding to an informational finding.

" } }, "low": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The severity of the finding is low and does require action on its own.

" + "smithy.api#documentation": "

A numeric value corresponding to a low severity finding.

" } }, "medium": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The severity of the finding is medium and should be addressed as a mid-term priority.

" + "smithy.api#documentation": "

A numeric value corresponding to a medium severity finding.

" } }, "high": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The severity of the finding is high and should be addressed as a near-term priority.

" + "smithy.api#documentation": "

A numeric value corresponding to a high severity finding.

" } }, "critical": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The severity of the finding is critical and should be addressed immediately.

" + "smithy.api#documentation": "

A numeric value corresponding to a critical finding.

" } } }, "traits": { - "smithy.api#documentation": "

The severity of the issue in the code that generated a finding.

" + "smithy.api#documentation": "

A numeric value corresponding to the severity of a finding, such as the number of open\n findings or the average time it takes to close findings of a given severity.

" } }, "com.amazonaws.codegurusecurity#Findings": { @@ -1556,7 +1564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use to get account level configuration.

", + "smithy.api#documentation": "

Use to get the encryption configuration for an account.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1578,7 +1586,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN to use for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration.

", + "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN that is used for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration. If you do not specify a\n customer-managed key, returns empty.

", "smithy.api#required": {} } } @@ -1652,11 +1660,11 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

", + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 1000 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, - "max": 100 + "max": 1000 } } }, @@ -1715,7 +1723,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns top level metrics about an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.

", + "smithy.api#documentation": "

Returns a summary of metrics for an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1730,7 +1738,7 @@ "date": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years since metrics data is only stored for two years. If a date\n outside of this range is passed, the response will be empty.

", + "smithy.api#documentation": "

The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years.

", "smithy.api#httpQuery": "date", "smithy.api#required": {} } @@ -1774,6 +1782,9 @@ }, { "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" } ], "traits": { @@ -1829,7 +1840,7 @@ "scanState": { "target": "com.amazonaws.codegurusecurity#ScanState", "traits": { - "smithy.api#documentation": "

The current state of the scan. Pass either InProgress,\n Successful, or Failed.

", + "smithy.api#documentation": "

The current state of the scan. Returns either InProgress,\n Successful, or Failed.

", "smithy.api#required": {} } }, @@ -1864,6 +1875,12 @@ "traits": { "smithy.api#documentation": "

The ARN for the scan name.

" } + }, + "errorMessage": { + "target": "com.amazonaws.codegurusecurity#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Details about the error that causes a scan to fail to be retrieved.

" + } } }, "traits": { @@ -1970,7 +1987,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

", + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 1000 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -1981,7 +1998,7 @@ "startDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start date of the interval which you want to retrieve metrics from.

", + "smithy.api#documentation": "

The start date of the interval which you want to retrieve metrics from. Rounds to the\n nearest day.

", "smithy.api#httpQuery": "startDate", "smithy.api#required": {} } @@ -1989,7 +2006,7 @@ "endDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end date of the interval which you want to retrieve metrics from.

", + "smithy.api#documentation": "

The end date of the interval which you want to retrieve metrics from. Round to the nearest\n day.

", "smithy.api#httpQuery": "endDate", "smithy.api#required": {} } @@ -2042,7 +2059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the standard scans in an account. Does not return express\n scans.

", + "smithy.api#documentation": "

Returns a list of all scans in an account. Does not return EXPRESS\n scans.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2070,7 +2087,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

", + "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 100 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2147,7 +2164,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

", + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2183,30 +2200,30 @@ "openFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of open findings of each severity in an account.

" + "smithy.api#documentation": "

The number of open findings of each severity.

" } }, "categoriesWithMostFindings": { "target": "com.amazonaws.codegurusecurity#CategoriesWithMostFindings", "traits": { - "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most open findings in an account.

" + "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most findings.

" } }, "scansWithMostOpenFindings": { "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenFindings", "traits": { - "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings in an account.

" + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings.

" } }, "scansWithMostOpenCriticalFindings": { "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenCriticalFindings", "traits": { - "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings in an account.

" + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings.

" } } }, "traits": { - "smithy.api#documentation": "

Information about summary metrics in an account.

" + "smithy.api#documentation": "

A summary of metrics for an account as of a specified date.

" } }, "com.amazonaws.codegurusecurity#NextToken": { @@ -2289,18 +2306,18 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier for the resource.

" + "smithy.api#documentation": "

The scanName of the scan that was run on the resource.

" } }, "subResourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier for a section of the resource, such as an AWS Lambda layer.

" + "smithy.api#documentation": "

The identifier for a section of the resource.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that\n contains a finding.

" + "smithy.api#documentation": "

Information about a resource that contains a finding.

" } }, "com.amazonaws.codegurusecurity#ResourceId": { @@ -2309,12 +2326,12 @@ "codeArtifactId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

The identifier for the code file uploaded to the resource where a finding was detected.

" + "smithy.api#documentation": "

The identifier for the code file uploaded to the resource object. Returned by\n CreateUploadUrl when you upload resources to be scanned.

" } } }, "traits": { - "smithy.api#documentation": "

The identifier for a resource object that contains resources where a finding was detected.

" + "smithy.api#documentation": "

The identifier for a resource object that contains resources to scan. Specifying a\n codeArtifactId is required to create a scan.

" } }, "com.amazonaws.codegurusecurity#ResourceNotFoundException": { @@ -2396,12 +2413,12 @@ "findingNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of open findings generated by a scan.

" + "smithy.api#documentation": "

The number of findings generated by a scan.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a scan with open findings.

" + "smithy.api#documentation": "

Information about the number of findings generated by a scan.

" } }, "com.amazonaws.codegurusecurity#ScanState": { @@ -2590,7 +2607,7 @@ "code": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The suggested code to add to your file.

" + "smithy.api#documentation": "

The suggested code fix. If applicable, includes code patch to replace your source code.

" } } }, @@ -2683,7 +2700,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

", + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2799,7 +2816,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

", + "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2850,7 +2867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use to update account-level configuration with an encryption key.

", + "smithy.api#documentation": "

Use to update the encryption configuration for an account.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2864,7 +2881,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.

", + "smithy.api#documentation": "

The customer-managed KMS key ARN you want to use for encryption. If not specified,\n CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a\n customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption\n instead, pass nothing.

", "smithy.api#required": {} } } @@ -2879,7 +2896,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN to use for\n encryption.

", + "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN that is used for\n encryption. If you did not specify a customer-managed KMS key in the request, returns empty.\n

", "smithy.api#required": {} } } @@ -3024,7 +3041,10 @@ "itemCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of times the vulnerability appears in your code.

" + "smithy.api#deprecated": { + "message": "This shape is not used." + }, + "smithy.api#documentation": "

The number of times the vulnerability appears in your code.

" } } },