diff --git a/codegen/sdk-codegen/aws-models/auditmanager.json b/codegen/sdk-codegen/aws-models/auditmanager.json index 88062b3f7ae..8a355823644 100644 --- a/codegen/sdk-codegen/aws-models/auditmanager.json +++ b/codegen/sdk-codegen/aws-models/auditmanager.json @@ -1121,7 +1121,7 @@ "destination": { "target": "com.amazonaws.auditmanager#S3Url", "traits": { - "smithy.api#documentation": "

The destination of the assessment report.

" + "smithy.api#documentation": "

The destination bucket where Audit Manager stores assessment reports.

" } } }, @@ -1609,12 +1609,15 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Uploads one or more pieces of evidence to a control in an Audit Manager assessment.\n You can upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by\n specifying the S3 URI of the evidence.

\n

You must upload manual evidence to your S3 bucket before you can upload it to your\n assessment. For instructions, see CreateBucket and PutObject in\n the Amazon Simple Storage Service API Reference.\n

\n

The following restrictions apply to this action:

\n \n

For more information about Audit Manager service restrictions, see Quotas and\n restrictions for Audit Manager.

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

Adds one or more pieces of evidence to a control in an Audit Manager assessment.

\n

You can import manual evidence from any S3 bucket by specifying the S3 URI of the\n object. You can also upload a file from your browser, or enter plain text in response to a\n risk assessment question.

\n

The following restrictions apply to this action:

\n \n

For more information about Audit Manager service restrictions, see Quotas and\n restrictions for Audit Manager.

", "smithy.api#http": { "method": "POST", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence", @@ -1792,6 +1795,9 @@ { "target": "com.amazonaws.auditmanager#GetEvidenceByEvidenceFolder" }, + { + "target": "com.amazonaws.auditmanager#GetEvidenceFileUploadUrl" + }, { "target": "com.amazonaws.auditmanager#GetEvidenceFolder" }, @@ -2270,8 +2276,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2283,8 +2289,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2296,8 +2302,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2309,8 +2315,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2322,8 +2328,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2335,8 +2341,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2348,8 +2354,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2361,8 +2367,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2374,8 +2380,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2387,8 +2393,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2400,8 +2406,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2413,8 +2419,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2426,8 +2432,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2439,8 +2445,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2452,8 +2458,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2465,8 +2471,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2478,8 +2484,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2491,8 +2497,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2504,8 +2510,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2517,8 +2523,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2530,8 +2536,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -2543,8 +2549,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2556,8 +2562,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2569,8 +2586,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2582,8 +2610,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -2595,8 +2634,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -2608,8 +2658,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -2621,8 +2671,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2634,8 +2684,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2646,8 +2696,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -2658,10 +2708,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -2753,7 +2809,7 @@ "type": { "target": "com.amazonaws.auditmanager#ControlType", "traits": { - "smithy.api#documentation": "

The type of control, such as a custom control or a standard control.

" + "smithy.api#documentation": "

Specifies whether the control is a standard control or a custom control.

" } }, "name": { @@ -3056,7 +3112,7 @@ "sourceFrequency": { "target": "com.amazonaws.auditmanager#SourceFrequency", "traits": { - "smithy.api#documentation": "

The frequency of evidence collection for the control mapping source.

" + "smithy.api#documentation": "

Specifies how often evidence is collected from the control mapping source.

" } }, "troubleshootingText": { @@ -3715,7 +3771,7 @@ "sourceFrequency": { "target": "com.amazonaws.auditmanager#SourceFrequency", "traits": { - "smithy.api#documentation": "

The frequency of evidence collection for the control mapping source.

" + "smithy.api#documentation": "

Specifies how often evidence is collected from the control mapping source.

" } }, "troubleshootingText": { @@ -3860,6 +3916,26 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$" } }, + "com.amazonaws.auditmanager#DefaultExportDestination": { + "type": "structure", + "members": { + "destinationType": { + "target": "com.amazonaws.auditmanager#ExportDestinationType", + "traits": { + "smithy.api#documentation": "

The destination type, such as Amazon S3.

" + } + }, + "destination": { + "target": "com.amazonaws.auditmanager#S3Url", + "traits": { + "smithy.api#documentation": "

The destination bucket where Audit Manager stores exported files.

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

The default s3 bucket where Audit Manager saves the files that you export from evidence finder.

" + } + }, "com.amazonaws.auditmanager#Delegation": { "type": "structure", "members": { @@ -4296,7 +4372,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom control in Audit Manager.

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

Deletes a custom control in Audit Manager.

\n \n

When you invoke this operation, the custom control is deleted from any frameworks or\n assessments that it’s currently part of. As a result, Audit Manager will stop\n collecting evidence for that custom control in all of your assessments. This includes\n assessments that you previously created before you deleted the custom control.

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/controls/{controlId}", @@ -4824,6 +4900,17 @@ "target": "com.amazonaws.auditmanager#NonEmptyString" } }, + "com.amazonaws.auditmanager#ExportDestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + } + }, "com.amazonaws.auditmanager#Filename": { "type": "string", "traits": { @@ -4858,13 +4945,13 @@ "type": { "target": "com.amazonaws.auditmanager#FrameworkType", "traits": { - "smithy.api#documentation": "

The framework type, such as a custom framework or a standard framework.

" + "smithy.api#documentation": "

Specifies whether the framework is a standard framework or a custom framework.

" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "

The compliance type that the new custom framework supports, such as CIS or HIPAA.\n

" + "smithy.api#documentation": "

The compliance type that the framework supports, such as CIS or HIPAA.

" } }, "description": { @@ -4882,7 +4969,7 @@ "controlSources": { "target": "com.amazonaws.auditmanager#ControlSources", "traits": { - "smithy.api#documentation": "

The sources that Audit Manager collects evidence from for the control.

" + "smithy.api#documentation": "

The control data sources where Audit Manager collects evidence from.

" } }, "controlSets": { @@ -5025,7 +5112,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the registration status of an account in Audit Manager.

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

Gets the registration status of an account in Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/account/status", @@ -5077,7 +5164,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an assessment from Audit Manager.

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

Gets information about a specified assessment.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}", @@ -5108,7 +5195,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a framework from Audit Manager.

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

Gets information about a specified framework.

", "smithy.api#http": { "method": "GET", "uri": "/assessmentFrameworks/{frameworkId}", @@ -5169,7 +5256,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the URL of an assessment report in Audit Manager.

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

Gets the URL of an assessment report in Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/reports/{assessmentReportId}/url", @@ -5265,7 +5352,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of changelogs from Audit Manager.

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

Gets a list of changelogs from Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/changelogs", @@ -5365,7 +5452,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a control from Audit Manager.

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

Gets information about a specified control.

", "smithy.api#http": { "method": "GET", "uri": "/controls/{controlId}", @@ -5395,7 +5482,7 @@ "control": { "target": "com.amazonaws.auditmanager#Control", "traits": { - "smithy.api#documentation": "

The name of the control that the GetControl API returned.

" + "smithy.api#documentation": "

The details of the control that the GetControl API returned.

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

Returns a list of delegations from an audit owner to a delegate.

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

Gets a list of delegations from an audit owner to a delegate.

", "smithy.api#http": { "method": "GET", "uri": "/delegations", @@ -5501,7 +5588,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns evidence from Audit Manager.

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

Gets information about a specified evidence item.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}", @@ -5532,7 +5619,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all evidence from a specified evidence folder in Audit Manager.

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

Gets all evidence from a specified evidence folder in Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence", @@ -5611,6 +5698,73 @@ "smithy.api#output": {} } }, + "com.amazonaws.auditmanager#GetEvidenceFileUploadUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a presigned Amazon S3 URL that can be used to upload a file as manual\n evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User\n Guide.

\n

The following restrictions apply to this operation:

\n \n

For more information about Audit Manager service restrictions, see Quotas and\n restrictions for Audit Manager.

", + "smithy.api#http": { + "method": "GET", + "uri": "/evidenceFileUploadUrl", + "code": 200 + } + } + }, + "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlRequest": { + "type": "structure", + "members": { + "fileName": { + "target": "com.amazonaws.auditmanager#ManualEvidenceLocalFileName", + "traits": { + "smithy.api#documentation": "

The file that you want to upload. For a list of supported file formats, see Supported file types for manual evidence in the Audit Manager\n User Guide.

", + "smithy.api#httpQuery": "fileName", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlResponse": { + "type": "structure", + "members": { + "evidenceFileName": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the uploaded manual evidence file that the presigned URL was generated\n for.

" + } + }, + "uploadUrl": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The presigned URL that was generated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.auditmanager#GetEvidenceFolder": { "type": "operation", "input": { @@ -5634,7 +5788,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an evidence folder from the specified assessment in Audit Manager.\n

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

Gets an evidence folder from a specified assessment in Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}", @@ -5711,7 +5865,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the evidence folders from a specified assessment in Audit Manager.\n

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

Gets the evidence folders from a specified assessment in Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/evidenceFolders", @@ -5747,7 +5901,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of evidence folders that are associated with a specified control in an\n Audit Manager assessment.

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

Gets a list of evidence folders that are associated with a specified control in an\n Audit Manager assessment.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}", @@ -6060,7 +6214,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the name of the delegated Amazon Web Services administrator account for the\n organization.

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

Gets the name of the delegated Amazon Web Services administrator account for a specified\n organization.

", "smithy.api#http": { "method": "GET", "uri": "/account/organizationAdminAccount", @@ -6115,7 +6269,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all of the Amazon Web Services that you can choose to include\n in your assessment. When you create an assessment, specify which of these services you want to include to\n narrow the assessment's scope.

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

Gets a list of all of the Amazon Web Services that you can choose to include in\n your assessment. When you create an assessment, specify which of these services you want to include to\n narrow the assessment's scope.

", "smithy.api#http": { "method": "GET", "uri": "/services", @@ -6161,7 +6315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the settings for the specified Amazon Web Services account.

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

Gets the settings for a specified Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/settings/{attribute}", @@ -6343,6 +6497,18 @@ "traits": { "smithy.api#enumValue": "SELECT_FROM_LIST" } + }, + "UPLOAD_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPLOAD_FILE" + } + }, + "INPUT_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPUT_TEXT" + } } } }, @@ -6628,7 +6794,7 @@ "frameworkMetadataList": { "target": "com.amazonaws.auditmanager#FrameworkMetadataList", "traits": { - "smithy.api#documentation": "

The list of metadata objects for the framework.

" + "smithy.api#documentation": "

A list of metadata that the ListAssessmentFrameworks API returns for each\n framework.

" } }, "nextToken": { @@ -6791,7 +6957,7 @@ "assessmentMetadata": { "target": "com.amazonaws.auditmanager#ListAssessmentMetadata", "traits": { - "smithy.api#documentation": "

The metadata that's associated with the assessment.

" + "smithy.api#documentation": "

The metadata that the ListAssessments API returns for each\n assessment.

" } }, "nextToken": { @@ -7124,7 +7290,7 @@ "controlMetadataList": { "target": "com.amazonaws.auditmanager#ControlMetadataList", "traits": { - "smithy.api#documentation": "

The list of control metadata objects that the ListControls API returned.\n

" + "smithy.api#documentation": "

A list of metadata that the ListControls API returns for each\n control.

" } }, "nextToken": { @@ -7360,12 +7526,24 @@ "s3ResourcePath": { "target": "com.amazonaws.auditmanager#S3Url", "traits": { - "smithy.api#documentation": "

The Amazon S3 URL that points to a manual evidence object.

" + "smithy.api#documentation": "

The S3 URL of the object that's imported as manual evidence.

" + } + }, + "textResponse": { + "target": "com.amazonaws.auditmanager#ManualEvidenceTextResponse", + "traits": { + "smithy.api#documentation": "

The plain text response that's entered and saved as manual evidence.

" + } + }, + "evidenceFileName": { + "target": "com.amazonaws.auditmanager#ManualEvidenceLocalFileName", + "traits": { + "smithy.api#documentation": "

The name of the file that's uploaded as manual evidence. This name is populated using\n the evidenceFileName value from the \n GetEvidenceFileUploadUrl\n API response.

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

Evidence that's uploaded to Audit Manager manually.

" + "smithy.api#documentation": "

Evidence that's manually added to a control in Audit Manager.\n manualEvidence can be one of the following: evidenceFileName,\n s3ResourcePath, or textResponse.

" } }, "com.amazonaws.auditmanager#ManualEvidenceList": { @@ -7380,6 +7558,26 @@ } } }, + "com.amazonaws.auditmanager#ManualEvidenceLocalFileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^[^\\/]*$" + } + }, + "com.amazonaws.auditmanager#ManualEvidenceTextResponse": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + } + }, "com.amazonaws.auditmanager#MaxResults": { "type": "integer", "traits": { @@ -7895,6 +8093,12 @@ "traits": { "smithy.api#enumValue": "DEREGISTRATION_POLICY" } + }, + "DEFAULT_EXPORT_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_EXPORT_DESTINATION" + } } } }, @@ -7916,7 +8120,7 @@ "defaultAssessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "

The default storage destination for assessment reports.

" + "smithy.api#documentation": "

The default S3 destination bucket for storing assessment reports.

" } }, "defaultProcessOwners": { @@ -7942,6 +8146,12 @@ "traits": { "smithy.api#documentation": "

The deregistration policy for your Audit Manager data. You can\n use this attribute to determine how your data is handled when you deregister Audit Manager.

" } + }, + "defaultExportDestination": { + "target": "com.amazonaws.auditmanager#DefaultExportDestination", + "traits": { + "smithy.api#documentation": "

The default S3 destination bucket for storing evidence finder exports.

" + } } }, "traits": { @@ -8100,18 +8310,18 @@ "keywordInputType": { "target": "com.amazonaws.auditmanager#KeywordInputType", "traits": { - "smithy.api#documentation": "

The input method for the keyword.

" + "smithy.api#documentation": "

The input method for the keyword.

\n " } }, "keywordValue": { "target": "com.amazonaws.auditmanager#KeywordValue", "traits": { - "smithy.api#documentation": "

The value of the keyword that's used when mapping a control data source. For example,\n this can be a CloudTrail event name, a rule name for Config, a\n Security Hub control, or the name of an Amazon Web Services API call.

\n

If you’re mapping a data source to a rule in Config, the\n keywordValue that you specify depends on the type of rule:

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

The value of the keyword that's used when mapping a control data source. For example,\n this can be a CloudTrail event name, a rule name for Config, a\n Security Hub control, or the name of an Amazon Web Services API call.

\n

If you’re mapping a data source to a rule in Config, the\n keywordValue that you specify depends on the type of rule:

\n \n \n

The keywordValue is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not\n successfully collect evidence from that data source as intended.

\n

Keep in mind the following requirements, depending on the data source type that\n you're using.

\n
    \n
  1. \n

    For Config:

    \n
      \n
    • \n

      For managed rules, make sure that the keywordValue is the rule identifier in\n ALL_CAPS_WITH_UNDERSCORES. For example,\n CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend\n that you reference the list of supported Config managed rules.

      \n
      • \n
    • \n

      For custom rules, make sure that the keywordValue has the Custom_\n prefix followed by the custom rule name. The format of the custom rule name\n itself may vary. For accuracy, we recommend that you visit the Config console to\n verify your custom rule name.

      \n
      • \n
    \n
    2. \n
  2. \n

    For Security Hub: The format varies for Security Hub control names.\n For accuracy, we recommend that you reference the list of supported\n Security Hub controls.

    \n
    3. \n
  3. \n

    For Amazon Web Services API calls: Make sure that the keywordValue\n is written as serviceprefix_ActionName. For example,\n iam_ListGroups. For accuracy, we recommend that you reference the\n list of supported\n API calls.

    \n
    4. \n
  4. \n

    For CloudTrail: Make sure that the keywordValue is written\n as serviceprefix_ActionName. For example,\n cloudtrail_StartLogging. For accuracy, we recommend that you\n review the Amazon Web Service prefix and action names in the Service Authorization Reference.

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

The keyword to search for in CloudTrail logs, Config rules,\n Security Hub checks, and Amazon Web Services API names.

\n

To learn more about the supported keywords that you can use when mapping a control data\n source, see the following pages in the Audit Manager User\n Guide:

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

A keyword that relates to the control data source.

\n

For manual evidence, this keyword indicates if the manual evidence is a file or\n text.

\n

For automated evidence, this keyword identifies a specific CloudTrail event,\n Config rule, Security Hub control, or Amazon Web Services API name.

\n

To learn more about the supported keywords that you can use when mapping a control data\n source, see the following pages in the Audit Manager User\n Guide:

\n " } }, "com.amazonaws.auditmanager#SourceName": { @@ -9197,7 +9407,7 @@ "defaultAssessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "

The default storage destination for assessment reports.

" + "smithy.api#documentation": "

The default S3 destination bucket for storing assessment reports.

" } }, "defaultProcessOwners": { @@ -9223,6 +9433,12 @@ "traits": { "smithy.api#documentation": "

The deregistration policy for your Audit Manager data. You can\n use this attribute to determine how your data is handled when you deregister Audit Manager.

" } + }, + "defaultExportDestination": { + "target": "com.amazonaws.auditmanager#DefaultExportDestination", + "traits": { + "smithy.api#documentation": "

The default S3 destination bucket for storing evidence finder exports.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/efs.json b/codegen/sdk-codegen/aws-models/efs.json index 06ecf5bb09a..56f669179d9 100644 --- a/codegen/sdk-codegen/aws-models/efs.json +++ b/codegen/sdk-codegen/aws-models/efs.json @@ -321,7 +321,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.

\n \n

If multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.

\n \n

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

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

Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.

\n \n

If multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1,000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.

\n \n

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

\n

Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting\n permissions to tag resources during creation.

", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/access-points", @@ -402,7 +402,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:

\n \n

Otherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.

\n \n

For basic use cases, you can use a randomly generated UUID for the creation\n token.

\n \n

The idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.

\n

For more information, see \n Creating a file system\n in the Amazon EFS User Guide.

\n \n

The CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.

\n \n

This operation accepts an optional PerformanceMode parameter that you\n choose for your file system. We recommend generalPurpose performance mode for\n most file systems. File systems using the maxIO performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.

\n

You can set the throughput mode for the file system using the ThroughputMode parameter.

\n

After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

\n

This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.

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

Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:

\n \n

Otherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.

\n \n

For basic use cases, you can use a randomly generated UUID for the creation\n token.

\n \n

The idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.

\n

For more information, see \n Creating a file system\n in the Amazon EFS User Guide.

\n \n

The CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.

\n \n

This operation accepts an optional PerformanceMode parameter that you\n choose for your file system. We recommend generalPurpose performance mode for\n most file systems. File systems using the maxIO performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.

\n

You can set the throughput mode for the file system using the ThroughputMode parameter.

\n

After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

\n

This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.

\n

File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting permissions to tag resources during creation.

", "smithy.api#http": { "method": "POST", "uri": "/2015-02-01/file-systems", @@ -1784,7 +1784,7 @@ "Status": { "target": "com.amazonaws.efs#ReplicationStatus", "traits": { - "smithy.api#documentation": "

Describes the status of the destination Amazon EFS file system. If the status is\n ERROR, the destination file system in the replication configuration is in a\n failed state and is unrecoverable. To access the file system data, restore a backup of the\n failed file system to a new file system.

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

Describes the status of the destination Amazon EFS file system.

\n ", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/guardduty.json b/codegen/sdk-codegen/aws-models/guardduty.json index 7b0205f4cee..e3faf72bfb2 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.json +++ b/codegen/sdk-codegen/aws-models/guardduty.json @@ -1790,7 +1790,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.

\n

When using Create Members as an organizations delegated administrator this\n action will enable GuardDuty in the added member accounts, with the exception of the\n organization delegated administrator account, which must enable GuardDuty prior to being added\n as a member.

\n

If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in\n potential member accounts and before using InviteMembers.

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

Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.

\n

As a delegated administrator, using CreateMembers will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.

\n

If you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.

\n

If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member", @@ -3606,7 +3606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the current GuardDuty member account from its administrator account.

\n

With autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.

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

Disassociates the current GuardDuty member account from its administrator account.

\n

When you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.

\n

With autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/administrator/disassociate", @@ -3658,7 +3658,7 @@ "smithy.api#deprecated": { "message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead" }, - "smithy.api#documentation": "

Disassociates the current GuardDuty member account from its administrator account.

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

Disassociates the current GuardDuty member account from its administrator account.

\n

When you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/master/disassociate", @@ -3713,7 +3713,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates GuardDuty member accounts (to the current administrator account) specified\n by the account IDs.

\n

With autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.

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

Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.

\n

When you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.

\n

With autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/disassociate", @@ -3768,7 +3768,7 @@ "Domain": { "target": "com.amazonaws.guardduty#String", "traits": { - "smithy.api#documentation": "

The domain information for the API request.

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

The domain information for the DNS query.

", "smithy.api#jsonName": "domain" } }, @@ -7538,7 +7538,7 @@ } ], "traits": { - "smithy.api#documentation": "

Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by\n CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage\n these accounts' findings on their behalf as the GuardDuty administrator account.

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

Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see Managing accounts with Amazon Web Services Organizations.

\n

To invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.

\n

After the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/invite", diff --git a/codegen/sdk-codegen/aws-models/location.json b/codegen/sdk-codegen/aws-models/location.json index e2b650b049d..0602e2c087c 100644 --- a/codegen/sdk-codegen/aws-models/location.json +++ b/codegen/sdk-codegen/aws-models/location.json @@ -98,7 +98,7 @@ "smithy.api#documentation": "

A list of allowed actions that an API key resource grants permissions to\n perform

\n \n

Currently, the only valid action is geo:GetMap* as an input to the\n list. For example, [\"geo:GetMap*\"] is valid but\n [\"geo:GetMapTile\"] is not.

\n ", "smithy.api#length": { "min": 1, - "max": 5 + "max": 7 }, "smithy.api#required": {} } @@ -783,6 +783,12 @@ "smithy.api#documentation": "

Contains the details of the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Each \n geofence polygon can have a maximum of 1,000 vertices.

\n ", "smithy.api#required": {} } + }, + "GeofenceProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

Specifies additional user-defined properties to store with the Geofence. An array \n of key-value pairs.

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

Uploads position update data for one or more devices to a tracker resource. Amazon Location\n uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 \n days.

\n \n

Position updates are handled based on the PositionFiltering property of the tracker. \n When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, \n and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than \n every 30 seconds, only one update per 30 seconds is stored for each unique device ID.

\n

When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than 30 m (98.4 ft).

\n

When PositionFiltering is set to AccuracyBased filtering,\n location data is stored and evaluated against linked geofence collections only if the\n device has moved more than the measured accuracy. For example, if two consecutive\n updates from a device have a horizontal accuracy of 5 m and 10 m, the second update\n is neither stored or evaluated if the device has moved less than 15 m. If\n PositionFiltering is set to AccuracyBased filtering, Amazon Location\n uses the default value { \"Horizontal\": 0} when accuracy is not provided on\n a DevicePositionUpdate.

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

Uploads position update data for one or more devices to a tracker resource (up to \n 10 devices per batch). Amazon Location uses the data when it reports the last known device \n position and position history. Amazon Location retains location data for 30 days.

\n \n

Position updates are handled based on the PositionFiltering \n property of the tracker. When PositionFiltering is set to \n TimeBased, updates are evaluated against linked geofence collections, \n and location data is stored at a maximum of one position per 30 second interval. \n If your update frequency is more often than every 30 seconds, only one update per \n 30 seconds is stored for each unique device ID.

\n

When PositionFiltering is set to DistanceBased \n filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than 30 m (98.4 ft).

\n

When PositionFiltering is set to AccuracyBased \n filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than the measured accuracy. For \n example, if two consecutive updates from a device have a horizontal accuracy of \n 5 m and 10 m, the second update is neither stored or evaluated if the device has \n moved less than 15 m. If PositionFiltering is set to \n AccuracyBased filtering, Amazon Location uses the default value \n { \"Horizontal\": 0} when accuracy is not provided on a\n DevicePositionUpdate.

\n ", "smithy.api#endpoint": { "hostPrefix": "tracking." }, @@ -934,7 +940,7 @@ "Updates": { "target": "com.amazonaws.location#DevicePositionUpdateList", "traits": { - "smithy.api#documentation": "

Contains the position update details for each device.

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

Contains the position update details for each device, up to 10 devices.

", "smithy.api#length": { "min": 1, "max": 10 @@ -3415,6 +3421,18 @@ ] } }, + "com.amazonaws.location#FilterPlaceCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#PlaceCategory" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.location#GenericResource": { "type": "resource", "identifiers": { @@ -3830,6 +3848,12 @@ "smithy.api#documentation": "

The timestamp for when the geofence collection was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n

", "smithy.api#required": {} } + }, + "GeofenceProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

Contains additional user-defined properties stored with the geofence. An array of \n key-value pairs.

" + } } } }, @@ -4796,6 +4820,12 @@ "smithy.api#documentation": "

The timestamp for when the geofence was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n

", "smithy.api#required": {} } + }, + "GeofenceProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

Contains additional user-defined properties stored with the geofence. An array of \n key-value pairs.

" + } } }, "traits": { @@ -6606,19 +6636,31 @@ "TimeZone": { "target": "com.amazonaws.location#TimeZone", "traits": { - "smithy.api#documentation": "

The time zone in which the Place is located. Returned only when using\n HERE as the selected partner.

" + "smithy.api#documentation": "

The time zone in which the Place is located. Returned only when using\n HERE or Grab as the selected partner.

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

For addresses with a UnitNumber, the type of unit. For example,\n Apartment.

" + "smithy.api#documentation": "

For addresses with a UnitNumber, the type of unit. For example,\n Apartment.

\n \n

Returned only for a place index that uses Esri as a data provider.

\n " } }, "UnitNumber": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.

\n \n

Returned only for a place index that uses Esri as a data provider. Is not returned\n for SearchPlaceIndexForPosition.

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

For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.

\n \n

Returned only for a place index that uses Esri or Grab as a data provider. Is \n not returned for SearchPlaceIndexForPosition.

\n " + } + }, + "Categories": { + "target": "com.amazonaws.location#PlaceCategoryList", + "traits": { + "smithy.api#documentation": "

The Amazon Location categories that describe this Place.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + } + }, + "SupplementalCategories": { + "target": "com.amazonaws.location#PlaceSupplementalCategoryList", + "traits": { + "smithy.api#documentation": "

Categories from the data provider that describe the Place that are not mapped\n to any Amazon Location categories.

" } } }, @@ -6626,6 +6668,26 @@ "smithy.api#documentation": "

Contains details about addresses or points of interest that match the search\n criteria.

\n

Not all details are included with all responses. Some details may only be returned by\n specific data partners.

" } }, + "com.amazonaws.location#PlaceCategory": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 35 + } + } + }, + "com.amazonaws.location#PlaceCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#PlaceCategory" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.location#PlaceGeometry": { "type": "structure", "members": { @@ -6696,6 +6758,26 @@ } } }, + "com.amazonaws.location#PlaceSupplementalCategory": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 35 + } + } + }, + "com.amazonaws.location#PlaceSupplementalCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#PlaceSupplementalCategory" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.location#Position": { "type": "list", "member": { @@ -6867,6 +6949,12 @@ "smithy.api#documentation": "

Contains the details to specify the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Each \n geofence polygon can have a maximum of 1,000 vertices.

\n ", "smithy.api#required": {} } + }, + "GeofenceProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

Specifies additional user-defined properties to store with the Geofence. An array \n of key-value pairs.

" + } } } }, @@ -7124,7 +7212,19 @@ "PlaceId": { "target": "com.amazonaws.location#PlaceId", "traits": { - "smithy.api#documentation": "

The unique identifier of the place. You can use this with the GetPlace\n operation to find the place again later.

\n \n

For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.

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

The unique identifier of the Place. You can use this with the GetPlace\n operation to find the place again later, or to get full information for the Place.

\n

The GetPlace request must use the same PlaceIndex \n resource as the SearchPlaceIndexForSuggestions that generated the Place \n ID.

\n \n

For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.

\n " + } + }, + "Categories": { + "target": "com.amazonaws.location#PlaceCategoryList", + "traits": { + "smithy.api#documentation": "

The Amazon Location categories that describe the Place.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + } + }, + "SupplementalCategories": { + "target": "com.amazonaws.location#PlaceSupplementalCategoryList", + "traits": { + "smithy.api#documentation": "

Categories from the data provider that describe the Place that are not mapped\n to any Amazon Location categories.

" } } }, @@ -7400,6 +7500,12 @@ "traits": { "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. If no language is specified,\n or not supported for a particular result, the partner automatically chooses a language\n for the result.

\n

For an example, we'll use the Greek language. You search for Athens, Gr\n to get suggestions with the language parameter set to en. The\n results found will most likely be returned as Athens, Greece.

\n

If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα, Ελλάδα.

\n

If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.

" } + }, + "FilterCategories": { + "target": "com.amazonaws.location#FilterPlaceCategoryList", + "traits": { + "smithy.api#documentation": "

A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + } } } }, @@ -7468,6 +7574,12 @@ "traits": { "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.

" } + }, + "FilterCategories": { + "target": "com.amazonaws.location#FilterPlaceCategoryList", + "traits": { + "smithy.api#documentation": "

The optional category filter specified in the request.

" + } } }, "traits": { @@ -7563,6 +7675,12 @@ "traits": { "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results, but not the results\n themselves. If no language is specified, or not supported for a particular result, the\n partner automatically chooses a language for the result.

\n

For an example, we'll use the Greek language. You search for Athens,\n Greece, with the language parameter set to en. The\n result found will most likely be returned as Athens.

\n

If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα.

\n

If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.

" } + }, + "FilterCategories": { + "target": "com.amazonaws.location#FilterPlaceCategoryList", + "traits": { + "smithy.api#documentation": "

A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.

\n

For more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.

" + } } } }, @@ -7638,6 +7756,12 @@ "traits": { "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.

" } + }, + "FilterCategories": { + "target": "com.amazonaws.location#FilterPlaceCategoryList", + "traits": { + "smithy.api#documentation": "

The optional category filter specified in the request.

" + } } }, "traits": {