From fe8a6c1f3b8d69e788b6c19f4f90c282bd80d9be Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Tue, 14 Nov 2023 19:09:37 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/backup.json | 831 +++++++++++++++++- .../sdk-codegen/aws-models/cleanrooms.json | 237 +++-- codegen/sdk-codegen/aws-models/connect.json | 55 +- codegen/sdk-codegen/aws-models/glue.json | 827 ++++++++++++++++- codegen/sdk-codegen/aws-models/iot.json | 465 ++++++---- codegen/sdk-codegen/aws-models/lambda.json | 6 + .../sdk-codegen/aws-models/mediatailor.json | 89 +- codegen/sdk-codegen/aws-models/pipes.json | 443 ++++++++-- .../aws-models/resource-explorer-2.json | 321 ++++++- codegen/sdk-codegen/aws-models/sagemaker.json | 14 +- codegen/sdk-codegen/aws-models/sfn.json | 339 ++++++- codegen/sdk-codegen/aws-models/signer.json | 128 +-- 12 files changed, 3208 insertions(+), 547 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/backup.json b/codegen/sdk-codegen/aws-models/backup.json index 0a1a679cfdc..b70eaf5e8c4 100644 --- a/codegen/sdk-codegen/aws-models/backup.json +++ b/codegen/sdk-codegen/aws-models/backup.json @@ -64,6 +64,29 @@ "target": "com.amazonaws.backup#AdvancedBackupSetting" } }, + "com.amazonaws.backup#AggregationPeriod": { + "type": "enum", + "members": { + "ONE_DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_DAY" + } + }, + "SEVEN_DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEVEN_DAYS" + } + }, + "FOURTEEN_DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOURTEEN_DAYS" + } + } + } + }, "com.amazonaws.backup#AlreadyExistsException": { "type": "structure", "members": { @@ -244,6 +267,12 @@ "traits": { "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" + } } }, "traits": { @@ -318,6 +347,140 @@ } } }, + "com.amazonaws.backup#BackupJobStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "ABORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTING" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "PARTIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL" + } + }, + "AGGREGATE_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGGREGATE_ALL" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, + "com.amazonaws.backup#BackupJobSummary": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.backup#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" + } + }, + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" + } + }, + "State": { + "target": "com.amazonaws.backup#BackupJobStatus", + "traits": { + "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types.

" + } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#MessageCategory", + "traits": { + "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" + } + }, + "Count": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" + } + }, + "StartTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + } + }, + "EndTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

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

This is a summary of jobs created \n or running within the most recent 30 days.

\n

The returned summary may contain the following: \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "com.amazonaws.backup#BackupJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#BackupJobSummary" + } + }, "com.amazonaws.backup#BackupJobsList": { "type": "list", "member": { @@ -1419,6 +1582,12 @@ "traits": { "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum

" + } } }, "traits": { @@ -1469,6 +1638,140 @@ } } }, + "com.amazonaws.backup#CopyJobStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "ABORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTING" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + }, + "COMPLETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PARTIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL" + } + }, + "AGGREGATE_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGGREGATE_ALL" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, + "com.amazonaws.backup#CopyJobSummary": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.backup#Region", + "traits": { + "smithy.api#documentation": "

This is the Amazon Web Services Regions within the job summary.

" + } + }, + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" + } + }, + "State": { + "target": "com.amazonaws.backup#CopyJobStatus", + "traits": { + "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types

" + } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#MessageCategory", + "traits": { + "smithy.api#documentation": "

This parameter is the job count for the specified \n message category.

\n

Example strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

" + } + }, + "Count": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" + } + }, + "StartTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + } + }, + "EndTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

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

This is a summary of copy jobs created \n or running within the most recent 30 days.

\n

The returned summary may contain the following: \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "com.amazonaws.backup#CopyJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#CopyJobSummary" + } + }, "com.amazonaws.backup#CopyJobsList": { "type": "list", "member": { @@ -2329,6 +2632,9 @@ { "target": "com.amazonaws.backup#ListBackupJobs" }, + { + "target": "com.amazonaws.backup#ListBackupJobSummaries" + }, { "target": "com.amazonaws.backup#ListBackupPlans" }, @@ -2347,6 +2653,9 @@ { "target": "com.amazonaws.backup#ListCopyJobs" }, + { + "target": "com.amazonaws.backup#ListCopyJobSummaries" + }, { "target": "com.amazonaws.backup#ListFrameworks" }, @@ -2377,6 +2686,9 @@ { "target": "com.amazonaws.backup#ListRestoreJobs" }, + { + "target": "com.amazonaws.backup#ListRestoreJobSummaries" + }, { "target": "com.amazonaws.backup#ListTags" }, @@ -2485,7 +2797,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2528,7 +2839,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2541,7 +2853,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2555,7 +2866,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2578,7 +2888,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2613,7 +2922,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2624,14 +2932,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2645,14 +2955,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -2661,11 +2969,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2676,14 +2984,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -2697,7 +3007,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -2717,7 +3026,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -2728,14 +3036,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2746,9 +3056,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3366,6 +3678,17 @@ "expect": { "error": "Invalid Configuration: Missing Region" } + }, + { + "documentation": "Partition doesn't support DualStack", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } } ], "version": "1.0" @@ -4122,6 +4445,12 @@ "traits": { "smithy.api#documentation": "

This is the non-unique name of the resource that \n belongs to the specified backup.

" } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the job count for the specified \n message category.

\n

Example strings may include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

" + } } }, "traits": { @@ -6331,6 +6660,119 @@ "smithy.api#error": "client" } }, + "com.amazonaws.backup#ListBackupJobSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListBackupJobSummariesInput" + }, + "output": { + "target": "com.amazonaws.backup#ListBackupJobSummariesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This is a request for a summary of backup jobs created \n or running within the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/backup-job-summaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListBackupJobSummariesInput": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", + "smithy.api#httpQuery": "AccountId" + } + }, + "State": { + "target": "com.amazonaws.backup#BackupJobStatus", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", + "smithy.api#httpQuery": "State" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", + "smithy.api#httpQuery": "ResourceType" + } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#MessageCategory", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "MessageCategory" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#AggregationPeriod", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n

Acceptable values include

\n ", + "smithy.api#httpQuery": "AggregationPeriod" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListBackupJobSummariesOutput": { + "type": "structure", + "members": { + "BackupJobSummaries": { + "target": "com.amazonaws.backup#BackupJobSummaryList", + "traits": { + "smithy.api#documentation": "

This request returns a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#ListBackupJobs": { "type": "operation", "input": { @@ -6449,6 +6891,13 @@ "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", "smithy.api#httpQuery": "parentJobId" } + }, + "ByMessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This returns a list of backup jobs for the specified \n message category.

\n

Example strings may include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of MessageCategory strings.

", + "smithy.api#httpQuery": "messageCategory" + } } }, "traits": { @@ -6912,6 +7361,119 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#ListCopyJobSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListCopyJobSummariesInput" + }, + "output": { + "target": "com.amazonaws.backup#ListCopyJobSummariesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This request obtains a list of copy jobs created \n or running within the the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, MessageCategory, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/copy-job-summaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListCopyJobSummariesInput": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", + "smithy.api#httpQuery": "AccountId" + } + }, + "State": { + "target": "com.amazonaws.backup#CopyJobStatus", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", + "smithy.api#httpQuery": "State" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", + "smithy.api#httpQuery": "ResourceType" + } + }, + "MessageCategory": { + "target": "com.amazonaws.backup#MessageCategory", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "MessageCategory" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#AggregationPeriod", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n ", + "smithy.api#httpQuery": "AggregationPeriod" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListCopyJobSummariesOutput": { + "type": "structure", + "members": { + "CopyJobSummaries": { + "target": "com.amazonaws.backup#CopyJobSummaryList", + "traits": { + "smithy.api#documentation": "

This return shows a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#ListCopyJobs": { "type": "operation", "input": { @@ -7029,6 +7591,13 @@ "smithy.api#documentation": "

This is a filter to list child (nested) jobs based on parent job ID.

", "smithy.api#httpQuery": "parentJobId" } + }, + "ByMessageCategory": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for the specified \n message category.

\n

Example accepted strings include AccessDenied, \n Success, and InvalidParameters. See \n Monitoring \n for a list of accepted MessageCategory strings.

\n

The the value ANY returns count of all message categories.

\n

\n AGGREGATE_ALL aggregates job counts \n for all message categories and returns the sum.

", + "smithy.api#httpQuery": "messageCategory" + } } }, "traits": { @@ -7857,6 +8426,112 @@ "smithy.api#output": {} } }, + "com.amazonaws.backup#ListRestoreJobSummaries": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListRestoreJobSummariesInput" + }, + "output": { + "target": "com.amazonaws.backup#ListRestoreJobSummariesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

This request obtains a summary of restore jobs created \n or running within the the most recent 30 days. You can \n include parameters AccountID, State, ResourceType, \n AggregationPeriod, MaxResults, or NextToken to filter \n results.

\n

This request returns a summary that contains \n Region, Account, State, RestourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/restore-job-summaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListRestoreJobSummariesInput": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified account.

\n

If the request is sent from a member account or an account \n not part of Amazon Web Services Organizations, jobs within requestor's account \n will be returned.

\n

Root, admin, and delegated administrator accounts can use \n the value ANY to return job counts from every account in the \n organization.

\n

\n AGGREGATE_ALL aggregates job counts \n from all accounts within the authenticated organization, \n then returns the sum.

", + "smithy.api#httpQuery": "AccountId" + } + }, + "State": { + "target": "com.amazonaws.backup#RestoreJobState", + "traits": { + "smithy.api#documentation": "

This parameter returns the job count for jobs \n with the specified state.

\n

The the value ANY returns count of all states.

\n

\n AGGREGATE_ALL aggregates job counts \n for all states and returns the sum.

", + "smithy.api#httpQuery": "State" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

Returns the job count for the specified resource type. \n Use request GetSupportedResourceTypes to obtain \n strings for supported resource types.

\n

The the value ANY returns count of all resource types.

\n

\n AGGREGATE_ALL aggregates job counts \n for all resource types and returns the sum.

\n

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

", + "smithy.api#httpQuery": "ResourceType" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#AggregationPeriod", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n

Acceptable values include

\n ", + "smithy.api#httpQuery": "AggregationPeriod" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

This parameter sets the maximum number of items \n to be returned.

\n

The value is an integer. Range of accepted values is from \n 1 to 500.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.backup#ListRestoreJobSummariesOutput": { + "type": "structure", + "members": { + "RestoreJobSummaries": { + "target": "com.amazonaws.backup#RestoreJobSummaryList", + "traits": { + "smithy.api#documentation": "

This return contains a summary that contains \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "AggregationPeriod": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

This is the period that sets the boundaries for returned \n results.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The next item following a partial list of returned resources. For example, if a request\n is made to return maxResults number of resources, NextToken\n allows you to return more items in your list starting at the location pointed to by the\n next token.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.backup#ListRestoreJobs": { "type": "operation", "input": { @@ -8093,6 +8768,9 @@ } } }, + "com.amazonaws.backup#MessageCategory": { + "type": "string" + }, "com.amazonaws.backup#Metadata": { "type": "map", "key": { @@ -8712,6 +9390,9 @@ "target": "com.amazonaws.backup#RecoveryPointMember" } }, + "com.amazonaws.backup#Region": { + "type": "string" + }, "com.amazonaws.backup#ReportDeliveryChannel": { "type": "structure", "members": { @@ -9036,6 +9717,59 @@ "com.amazonaws.backup#RestoreJobId": { "type": "string" }, + "com.amazonaws.backup#RestoreJobState": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "ABORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABORTED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "AGGREGATE_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGGREGATE_ALL" + } + }, + "ANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY" + } + } + } + }, "com.amazonaws.backup#RestoreJobStatus": { "type": "enum", "members": { @@ -9071,6 +9805,63 @@ } } }, + "com.amazonaws.backup#RestoreJobSummary": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.backup#Region", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Regions within the job summary.

" + } + }, + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

The account ID that owns the jobs within the summary.

" + } + }, + "State": { + "target": "com.amazonaws.backup#RestoreJobState", + "traits": { + "smithy.api#documentation": "

This value is job count for jobs \n with the specified state.

" + } + }, + "ResourceType": { + "target": "com.amazonaws.backup#ResourceType", + "traits": { + "smithy.api#documentation": "

This value is the job count for the specified resource type. \n The request GetSupportedResourceTypes returns \n strings for supported resource types.

" + } + }, + "Count": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value as a number of jobs in a job summary.

" + } + }, + "StartTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The value of time in number format of a job start time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + } + }, + "EndTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The value of time in number format of a job end time.

\n

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

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

This is a summary of restore jobs created \n or running within the most recent 30 days.

\n

The returned summary may contain the following: \n Region, Account, State, ResourceType, MessageCategory, \n StartTime, EndTime, and Count of included jobs.

" + } + }, + "com.amazonaws.backup#RestoreJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#RestoreJobSummary" + } + }, "com.amazonaws.backup#RestoreJobsList": { "type": "list", "member": { diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index cb3aac82da8..64f22baae13 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -113,7 +113,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -132,7 +131,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -160,13 +158,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -179,7 +178,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -193,7 +191,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -216,7 +213,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -251,11 +247,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -266,16 +260,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -289,14 +286,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -305,15 +300,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -324,16 +318,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -347,7 +344,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -367,11 +363,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -382,20 +376,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -406,18 +402,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -1405,7 +1405,7 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.cleanrooms#AnalysisTemplateResource": { @@ -1532,7 +1532,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 15000 + "max": 90000 } } }, @@ -2084,7 +2084,7 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.cleanrooms#CollaborationName": { @@ -2609,7 +2609,7 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.cleanrooms#ConfiguredTableAssociationResource": { @@ -2727,7 +2727,7 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.cleanrooms#ConfiguredTableResource": { @@ -3091,6 +3091,12 @@ "traits": { "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } + }, + "creatorPaymentConfiguration": { + "target": "com.amazonaws.cleanrooms#PaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The collaboration\n creator's payment responsibilities set by the collaboration creator.

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" + } } } }, @@ -3441,7 +3447,7 @@ "queryLogStatus": { "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

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

An indicator as to whether query logging has been enabled or disabled for the\n membership.

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

The default\n protected query result configuration as specified by the member who can receive\n results.

" } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

\n

Not required if the collaboration member has the member ability to run queries.

\n

Required if the collaboration member doesn't have the member ability to run queries but\n is configured as a payer by the collaboration creator.

" + } } } }, @@ -3477,28 +3489,28 @@ "allowCleartext": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data (true) or are to\n cryptographically process every column (false).

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

Indicates whether encrypted tables can contain cleartext data\n (TRUE)\n or are to cryptographically process every column\n (FALSE).

", "smithy.api#required": {} } }, "allowDuplicates": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to\n contain only non-repeated values (false).

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

Indicates whether Fingerprint columns can contain duplicate entries\n (TRUE)\n or are to contain only non-repeated values\n (FALSE).

", "smithy.api#required": {} } }, "allowJoinsOnColumnsWithDifferentNames": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name (true) or can only be joined on Fingerprint columns of the same name\n (false).

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

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name\n (TRUE)\n or can only be joined on Fingerprint columns of the same name\n (FALSE).

", "smithy.api#required": {} } }, "preserveNulls": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or\n cryptographically processed (false).

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

Indicates whether NULL values are to be copied as NULL to encrypted tables\n (TRUE)\n or cryptographically processed\n (FALSE).

", "smithy.api#required": {} } } @@ -5628,6 +5640,12 @@ "smithy.api#documentation": "

The member's display name.

", "smithy.api#required": {} } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#PaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator.\n

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.

" + } } }, "traits": { @@ -5671,7 +5689,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MemberStatus", "traits": { - "smithy.api#documentation": "

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and\n `REMOVED`.

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

The status of the member.\n

", "smithy.api#required": {} } }, @@ -5714,6 +5732,13 @@ "traits": { "smithy.api#documentation": "

The unique ARN for the member's associated membership, if present.

" } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#PaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator.\n

", + "smithy.api#required": {} + } } }, "traits": { @@ -5796,7 +5821,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and\n `COLLABORATION_DELETED`.

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

The status of the\n membership.

", "smithy.api#required": {} } }, @@ -5810,14 +5835,21 @@ "queryLogStatus": { "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

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

An indicator as to whether query logging has been enabled or disabled for the\n membership.

", "smithy.api#required": {} } }, "defaultResultConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + "smithy.api#documentation": "

The default protected query result configuration as specified by the member who can\n receive results.

" + } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

", + "smithy.api#required": {} } } }, @@ -5841,7 +5873,22 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.cleanrooms#MembershipPaymentConfiguration": { + "type": "structure", + "members": { + "queryCompute": { + "target": "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member for query compute\n costs.

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

An object\n representing the payment responsibilities accepted by the collaboration\n member.

" } }, "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration": { @@ -5852,7 +5899,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains\n configurations for protected query results.

" + "smithy.api#documentation": "

Contains configurations for protected query results.

" } }, "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration": { @@ -5861,19 +5908,34 @@ "outputConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration", "traits": { - "smithy.api#documentation": "

Configuration for\n protected query results.

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

Configuration for protected query results.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.cleanrooms#RoleArn", "traits": { - "smithy.api#documentation": "

The unique ARN for\n an IAM role that is used by Clean Rooms to write protected query results to the\n result location, given by the member who can receive results.

" + "smithy.api#documentation": "

The unique ARN for an IAM role that is used by Clean Rooms to write protected\n query results to the result location, given by the member who can receive results.

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

Contains\n configurations for protected query results.

" + "smithy.api#documentation": "

Contains configurations for protected query results.

" + } + }, + "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig": { + "type": "structure", + "members": { + "isResponsible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether\n the collaboration member has accepted to pay for query compute costs (TRUE) or\n has not accepted to pay for query compute costs\n (FALSE).

\n

If the collaboration creator has not specified anyone to pay for query compute costs,\n then the member who can query is the default payer.

\n

An error message is returned for the following reasons:

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

An object\n representing the payment responsibilities accepted by the collaboration member for query\n compute costs.

" } }, "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { @@ -6027,7 +6089,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and\n `COLLABORATION_DELETED`.

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

The status of the\n membership.

", "smithy.api#required": {} } }, @@ -6037,6 +6099,13 @@ "smithy.api#documentation": "

The abilities granted to the collaboration member.

", "smithy.api#required": {} } + }, + "paymentConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", + "traits": { + "smithy.api#documentation": "

The payment\n responsibilities accepted by the collaboration member.

", + "smithy.api#required": {} + } } }, "traits": { @@ -6180,6 +6249,21 @@ } } }, + "com.amazonaws.cleanrooms#PaymentConfiguration": { + "type": "structure", + "members": { + "queryCompute": { + "target": "com.amazonaws.cleanrooms#QueryComputePaymentConfig", + "traits": { + "smithy.api#documentation": "

The collaboration\n member's payment responsibilities set by the collaboration creator for query compute\n costs.

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

An object\n representing the collaboration member's payment responsibilities set by the collaboration\n creator.

" + } + }, "com.amazonaws.cleanrooms#ProtectedQuery": { "type": "structure", "members": { @@ -6280,10 +6364,10 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList": { @@ -6304,7 +6388,7 @@ "memberList": { "target": "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList", "traits": { - "smithy.api#documentation": "

The list of member\n Amazon Web Services account(s) that received the results of the query.

" + "smithy.api#documentation": "

The list of member Amazon Web Services account(s) that received the results of the query.

" } } }, @@ -6412,7 +6496,7 @@ "traits": { "smithy.api#documentation": "

The query string to be submitted.

", "smithy.api#length": { - "max": 15000 + "max": 90000 } } }, @@ -6440,13 +6524,13 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services account\n ID of the member in the collaboration who can receive results for the\n query.

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

The Amazon Web Services account ID of the member in the collaboration who can receive results for the\n query.

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

Details about the\n member who received the query result.

" + "smithy.api#documentation": "

Details about the member who received the query result.

" } }, "com.amazonaws.cleanrooms#ProtectedQueryStatistics": { @@ -6559,6 +6643,21 @@ ] } }, + "com.amazonaws.cleanrooms#QueryComputePaymentConfig": { + "type": "structure", + "members": { + "isResponsible": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether\n the collaboration creator has configured the collaboration member to pay for query compute\n costs (TRUE) or has not configured the collaboration member to pay for query\n compute costs (FALSE).

\n

Exactly one member can be configured to pay for query compute costs. An error is\n returned if the collaboration creator sets a TRUE value for more than one\n member in the collaboration.

\n

If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer. An error is returned if\n the collaboration creator sets a FALSE value for the member who can\n query.

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

An object\n representing the collaboration member's payment responsibilities set by the collaboration\n creator for query compute costs.

" + } + }, "com.amazonaws.cleanrooms#QueryTables": { "type": "list", "member": { @@ -6658,7 +6757,7 @@ "min": 32, "max": 512 }, - "smithy.api#pattern": "^arn:aws:iam::[\\w]+:role/[\\w+=,./@-]+$" + "smithy.api#pattern": "^arn:aws:iam::[\\w]+:role/[\\w+=./@-]+$" } }, "com.amazonaws.cleanrooms#ScalarFunctions": { @@ -6906,14 +7005,14 @@ } }, "com.amazonaws.cleanrooms#SchemaType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "TABLE", - "value": "TABLE" + "type": "enum", + "members": { + "TABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABLE" } - ] + } } }, "com.amazonaws.cleanrooms#ServiceQuotaExceededException": { @@ -7204,7 +7303,7 @@ "min": 36, "max": 36 }, - "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.cleanrooms#UntagResource": { @@ -7708,13 +7807,13 @@ "queryLogStatus": { "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", "traits": { - "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

" + "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n membership.

" } }, "defaultResultConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + "smithy.api#documentation": "

The default protected query result configuration as specified by the member who can\n receive results.

" } } } diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 534f535fdd6..db493ea282d 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -3154,7 +3154,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

Only the Amazon Connect outbound campaigns service principal is allowed to assume a\n role in your account and call this API.

\n \n

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns\n capability ingests dial requests via the PutDialRequestBatch\n API. It then uses BatchPutContact to create contacts corresponding to those\n dial requests. If agents are available, the dial requests are dialed out, which results in a\n voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.\n

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

Only the Amazon Connect outbound campaigns service principal is allowed to assume a\n role in your account and call this API.

\n \n

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns\n capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding\n to those dial requests. If agents are available, the dial requests are dialed out, which results\n in a voice call. The resulting voice call uses the same contactId that was created by\n BatchPutContact.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/batch/{InstanceId}", @@ -5275,7 +5275,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see \n Enable persistent chat in the \n Amazon Connect Administrator Guide.\n

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

Enables rehydration of chats for the lifespan of a contact. For more information about chat\n rehydration, see Enable persistent chat in the\n Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/contact/persistent-contact-association/{InstanceId}/{InitialContactId}", @@ -5297,7 +5297,7 @@ "InitialContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

This is the contactId of the current contact that the\n CreatePersistentContactAssociation API is being called from.

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

This is the contactId of the current contact that the\n CreatePersistentContactAssociation API is being called from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5305,7 +5305,7 @@ "RehydrationType": { "target": "com.amazonaws.connect#RehydrationType", "traits": { - "smithy.api#documentation": "

The contactId chosen for rehydration depends on the type chosen.

\n \n

The actual contactId used for rehydration is provided in the response of this API.

\n

To illustrate how to use rehydration type, consider the following example: A customer starts\n a chat session. Agent a1 accepts the chat and a conversation starts between the customer and\n Agent a1. This first contact creates a contact ID C1. Agent a1\n then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the\n disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and\n wants to resume their past chat session. At this point, the customer can have following use\n cases:

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

The contactId chosen for rehydration depends on the type chosen.

\n \n

The actual contactId used for rehydration is provided in the response of this API.

\n

To illustrate how to use rehydration type, consider the following example: A customer starts\n a chat session. Agent a1 accepts the chat and a conversation starts between the customer and\n Agent a1. This first contact creates a contact ID C1. Agent a1\n then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the\n disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and\n wants to resume their past chat session. At this point, the customer can have following use\n cases:

\n ", "smithy.api#required": {} } }, @@ -25692,6 +25692,47 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.connect#SegmentAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.connect#SegmentAttributeValue": { + "type": "structure", + "members": { + "ValueString": { + "target": "com.amazonaws.connect#SegmentAttributeValueString", + "traits": { + "smithy.api#documentation": "

The value of a segment attribute.

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

A value for a segment attribute. This is structured as a map where the key is\n valueString and the value is a string.

" + } + }, + "com.amazonaws.connect#SegmentAttributeValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.connect#SegmentAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#SegmentAttributeName" + }, + "value": { + "target": "com.amazonaws.connect#SegmentAttributeValue" + } + }, "com.amazonaws.connect#SendNotificationActionDefinition": { "type": "structure", "members": { @@ -25999,6 +26040,12 @@ "traits": { "smithy.api#documentation": "

The unique identifier for an Amazon Connect contact. This identifier is related to the\n chat starting.

\n \n

You cannot provide data for both RelatedContactId and PersistentChat.

\n " } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#SegmentAttributes", + "traits": { + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in\n flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n \n

The types application/vnd.amazonaws.connect.message.interactive and\n application/vnd.amazonaws.connect.message.interactive.response must be present in the\n SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {\n \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}.

\n " + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index 27318802481..2eaee02b9e5 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -69,6 +69,9 @@ { "target": "com.amazonaws.glue#BatchGetPartition" }, + { + "target": "com.amazonaws.glue#BatchGetTableOptimizer" + }, { "target": "com.amazonaws.glue#BatchGetTriggers" }, @@ -150,6 +153,9 @@ { "target": "com.amazonaws.glue#CreateTable" }, + { + "target": "com.amazonaws.glue#CreateTableOptimizer" + }, { "target": "com.amazonaws.glue#CreateTrigger" }, @@ -222,6 +228,9 @@ { "target": "com.amazonaws.glue#DeleteTable" }, + { + "target": "com.amazonaws.glue#DeleteTableOptimizer" + }, { "target": "com.amazonaws.glue#DeleteTableVersion" }, @@ -384,6 +393,9 @@ { "target": "com.amazonaws.glue#GetTable" }, + { + "target": "com.amazonaws.glue#GetTableOptimizer" + }, { "target": "com.amazonaws.glue#GetTables" }, @@ -480,6 +492,9 @@ { "target": "com.amazonaws.glue#ListStatements" }, + { + "target": "com.amazonaws.glue#ListTableOptimizerRuns" + }, { "target": "com.amazonaws.glue#ListTriggers" }, @@ -630,6 +645,9 @@ { "target": "com.amazonaws.glue#UpdateTable" }, + { + "target": "com.amazonaws.glue#UpdateTableOptimizer" + }, { "target": "com.amazonaws.glue#UpdateTrigger" }, @@ -2182,6 +2200,15 @@ "smithy.api#documentation": "

Specifies a transform that maps data property keys in the data source to data property keys in the data target. You can rename keys, modify the data types for keys, and choose which keys to drop from the dataset.

" } }, + "com.amazonaws.glue#ArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, "com.amazonaws.glue#AthenaConnectorSource": { "type": "structure", "members": { @@ -3286,6 +3313,140 @@ } } }, + "com.amazonaws.glue#BatchGetTableOptimizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#BatchGetTableOptimizerRequest" + }, + "output": { + "target": "com.amazonaws.glue#BatchGetTableOptimizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the configuration for the specified table optimizers.

" + } + }, + "com.amazonaws.glue#BatchGetTableOptimizerEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#BatchGetTableOptimizerEntry" + } + }, + "com.amazonaws.glue#BatchGetTableOptimizerEntry": { + "type": "structure", + "members": { + "catalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

" + } + }, + "databaseName": { + "target": "com.amazonaws.glue#databaseNameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

" + } + }, + "tableName": { + "target": "com.amazonaws.glue#tableNameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer.

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

Represents a table optimizer to retrieve in the BatchGetTableOptimizer operation.

" + } + }, + "com.amazonaws.glue#BatchGetTableOptimizerError": { + "type": "structure", + "members": { + "error": { + "target": "com.amazonaws.glue#ErrorDetail", + "traits": { + "smithy.api#documentation": "

An ErrorDetail object containing code and message details about the error.

" + } + }, + "catalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

" + } + }, + "databaseName": { + "target": "com.amazonaws.glue#databaseNameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

" + } + }, + "tableName": { + "target": "com.amazonaws.glue#tableNameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer.

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

Contains details on one of the errors in the error list returned by the BatchGetTableOptimizer operation.

" + } + }, + "com.amazonaws.glue#BatchGetTableOptimizerErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#BatchGetTableOptimizerError" + } + }, + "com.amazonaws.glue#BatchGetTableOptimizerRequest": { + "type": "structure", + "members": { + "Entries": { + "target": "com.amazonaws.glue#BatchGetTableOptimizerEntries", + "traits": { + "smithy.api#documentation": "

A list of BatchGetTableOptimizerEntry objects specifying the table optimizers to retrieve.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#BatchGetTableOptimizerResponse": { + "type": "structure", + "members": { + "TableOptimizers": { + "target": "com.amazonaws.glue#BatchTableOptimizers", + "traits": { + "smithy.api#documentation": "

A list of BatchTableOptimizer objects.

" + } + }, + "Failures": { + "target": "com.amazonaws.glue#BatchGetTableOptimizerErrors", + "traits": { + "smithy.api#documentation": "

A list of errors from the operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#BatchGetTriggers": { "type": "operation", "input": { @@ -3552,6 +3713,44 @@ "target": "com.amazonaws.glue#BatchStopJobRunSuccessfulSubmission" } }, + "com.amazonaws.glue#BatchTableOptimizer": { + "type": "structure", + "members": { + "catalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

" + } + }, + "databaseName": { + "target": "com.amazonaws.glue#databaseNameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

" + } + }, + "tableName": { + "target": "com.amazonaws.glue#tableNameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "tableOptimizer": { + "target": "com.amazonaws.glue#TableOptimizer", + "traits": { + "smithy.api#documentation": "

A TableOptimizer object that contains details on the configuration and last run of a table optimzer.

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

Contains details for one of the table optimizers returned by the BatchGetTableOptimizer operation.

" + } + }, + "com.amazonaws.glue#BatchTableOptimizers": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#BatchTableOptimizer" + } + }, "com.amazonaws.glue#BatchUpdatePartition": { "type": "operation", "input": { @@ -9232,6 +9431,85 @@ "smithy.api#documentation": "

Creates a new table definition in the Data Catalog.

" } }, + "com.amazonaws.glue#CreateTableOptimizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateTableOptimizerRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateTableOptimizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new table optimizer for a specific function. compaction is the only currently supported optimizer type.

" + } + }, + "com.amazonaws.glue#CreateTableOptimizerRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer. Currently, the only valid value is compaction.

", + "smithy.api#required": {} + } + }, + "TableOptimizerConfiguration": { + "target": "com.amazonaws.glue#TableOptimizerConfiguration", + "traits": { + "smithy.api#documentation": "

A TableOptimizerConfiguration object representing the configuration of a table optimizer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#CreateTableOptimizerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#CreateTableRequest": { "type": "structure", "members": { @@ -12123,6 +12401,75 @@ "smithy.api#documentation": "

Removes a table definition from the Data Catalog.

\n \n

After completing this operation, you no longer have access to the table versions and\n partitions that belong to the deleted table. Glue deletes these \"orphaned\" resources\n asynchronously in a timely manner, at the discretion of the service.

\n

To ensure the immediate deletion of all related resources, before calling\n DeleteTable, use DeleteTableVersion or\n BatchDeleteTableVersion, and DeletePartition or\n BatchDeletePartition, to delete any resources that belong to the\n table.

\n " } }, + "com.amazonaws.glue#DeleteTableOptimizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteTableOptimizerRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteTableOptimizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.

" + } + }, + "com.amazonaws.glue#DeleteTableOptimizerRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#DeleteTableOptimizerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#DeleteTableRequest": { "type": "structure", "members": { @@ -18162,6 +18509,100 @@ "smithy.api#documentation": "

Retrieves the Table definition in a Data Catalog for\n a specified table.

" } }, + "com.amazonaws.glue#GetTableOptimizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetTableOptimizerRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetTableOptimizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the configuration of all optimizers associated with a specified table.

" + } + }, + "com.amazonaws.glue#GetTableOptimizerRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#GetTableOptimizerResponse": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

" + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "TableOptimizer": { + "target": "com.amazonaws.glue#TableOptimizer", + "traits": { + "smithy.api#documentation": "

The optimizer associated with the specified table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#GetTableRequest": { "type": "structure", "members": { @@ -23335,6 +23776,127 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#ListTableOptimizerRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListTableOptimizerRunsRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListTableOptimizerRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the history of previous optimizer runs for a specific table.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListTableOptimizerRunsRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer. Currently, the only valid value is compaction.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#MaxListTableOptimizerRunsTokenResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The maximum number of optimizer runs to return on each call.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#ListTableOptimizerRunsToken", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#ListTableOptimizerRunsResponse": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

" + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#ListTableOptimizerRunsToken", + "traits": { + "smithy.api#documentation": "

A continuation token for paginating the returned list of optimizer runs, returned if the current segment of the list is not the last.

" + } + }, + "TableOptimizerRuns": { + "target": "com.amazonaws.glue#TableOptimizerRuns", + "traits": { + "smithy.api#documentation": "

A list of the optimizer runs associated with a table.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.glue#ListTableOptimizerRunsToken": { + "type": "string" + }, "com.amazonaws.glue#ListTriggers": { "type": "operation", "input": { @@ -23965,6 +24527,12 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#MaxListTableOptimizerRunsTokenResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.glue#MaxResultsNumber": { "type": "integer", "traits": { @@ -26970,6 +27538,38 @@ "com.amazonaws.glue#RunId": { "type": "string" }, + "com.amazonaws.glue#RunMetrics": { + "type": "structure", + "members": { + "NumberOfBytesCompacted": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

The number of bytes removed by the compaction job run.

" + } + }, + "NumberOfFilesCompacted": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

The number of files removed by the compaction job run.

" + } + }, + "NumberOfDpus": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

The number of DPU hours consumed by the job.

" + } + }, + "JobDurationInHour": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

The duration of the job in hours.

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

Metrics for the optimizer run.

" + } + }, "com.amazonaws.glue#RunStatement": { "type": "operation", "input": { @@ -29868,7 +30468,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

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

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

\n

Recommendation runs are automatically deleted after 90 days.

", "smithy.api#idempotent": {} } }, @@ -31489,6 +32089,139 @@ "com.amazonaws.glue#TableName": { "type": "string" }, + "com.amazonaws.glue#TableOptimizer": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer. Currently, the only valid value is compaction.

" + } + }, + "configuration": { + "target": "com.amazonaws.glue#TableOptimizerConfiguration", + "traits": { + "smithy.api#documentation": "

A TableOptimizerConfiguration object that was specified when creating or updating a table optimizer.

" + } + }, + "lastRun": { + "target": "com.amazonaws.glue#TableOptimizerRun", + "traits": { + "smithy.api#documentation": "

A TableOptimizerRun object representing the last run of the table optimizer.

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

Contains details about an optimizer associated with a table.

" + } + }, + "com.amazonaws.glue#TableOptimizerConfiguration": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.glue#ArnString", + "traits": { + "smithy.api#documentation": "

A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf.

" + } + }, + "enabled": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Whether table optimization is enabled.

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

Contains details on the configuration of a table optimizer. You pass this configuration when creating or updating a table optimizer.

" + } + }, + "com.amazonaws.glue#TableOptimizerEventType": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "starting" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "completed" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in_progress" + } + } + } + }, + "com.amazonaws.glue#TableOptimizerRun": { + "type": "structure", + "members": { + "eventType": { + "target": "com.amazonaws.glue#TableOptimizerEventType", + "traits": { + "smithy.api#documentation": "

An event type representing the status of the table optimizer run.

" + } + }, + "startTimestamp": { + "target": "com.amazonaws.glue#TableOptimizerRunTimestamp", + "traits": { + "smithy.api#documentation": "

Represents the epoch timestamp at which the compaction job was started within Lake Formation.

" + } + }, + "endTimestamp": { + "target": "com.amazonaws.glue#TableOptimizerRunTimestamp", + "traits": { + "smithy.api#documentation": "

Represents the epoch timestamp at which the compaction job ended.

" + } + }, + "metrics": { + "target": "com.amazonaws.glue#RunMetrics", + "traits": { + "smithy.api#documentation": "

A RunMetrics object containing metrics for the optimizer run.

" + } + }, + "error": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

An error that occured during the optimizer run.

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

Contains details for a table optimizer run.

" + } + }, + "com.amazonaws.glue#TableOptimizerRunTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.glue#TableOptimizerRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#TableOptimizerRun" + } + }, + "com.amazonaws.glue#TableOptimizerType": { + "type": "enum", + "members": { + "COMPACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "compaction" + } + } + } + }, "com.amazonaws.glue#TablePrefix": { "type": "string", "traits": { @@ -34332,6 +35065,82 @@ "smithy.api#documentation": "

Updates a metadata table in the Data Catalog.

" } }, + "com.amazonaws.glue#UpdateTableOptimizer": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateTableOptimizerRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateTableOptimizerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configuration for an existing table optimizer.

" + } + }, + "com.amazonaws.glue#UpdateTableOptimizerRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#documentation": "

The Catalog ID of the table.

", + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the database in the catalog in which the table resides.

", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the table.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.glue#TableOptimizerType", + "traits": { + "smithy.api#documentation": "

The type of table optimizer. Currently, the only valid value is compaction.

", + "smithy.api#required": {} + } + }, + "TableOptimizerConfiguration": { + "target": "com.amazonaws.glue#TableOptimizerConfiguration", + "traits": { + "smithy.api#documentation": "

A TableOptimizerConfiguration object representing the configuration of a table optimizer.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.glue#UpdateTableOptimizerResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.glue#UpdateTableRequest": { "type": "structure", "members": { @@ -35238,6 +36047,22 @@ "traits": { "smithy.api#documentation": "

A classifier for XML content.

" } + }, + "com.amazonaws.glue#databaseNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.glue#tableNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } } } } diff --git a/codegen/sdk-codegen/aws-models/iot.json b/codegen/sdk-codegen/aws-models/iot.json index 357301ba5fb..3eac824546e 100644 --- a/codegen/sdk-codegen/aws-models/iot.json +++ b/codegen/sdk-codegen/aws-models/iot.json @@ -2965,7 +2965,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a Device Defender security profile with a thing group or this account. Each \n thing group or account can have up to five security profiles associated with it.

\n

Requires permission to access the AttachSecurityProfile action.

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

Associates a Device Defender security profile with a thing group or this account. Each\n thing group or account can have up to five security profiles associated with it.

\n

Requires permission to access the AttachSecurityProfile action.

", "smithy.api#http": { "method": "PUT", "uri": "/security-profiles/{securityProfileName}/targets", @@ -4400,6 +4400,12 @@ "traits": { "smithy.api#documentation": "

\n Suppresses alerts.\n

" } + }, + "exportMetric": { + "target": "com.amazonaws.iot#ExportMetric", + "traits": { + "smithy.api#documentation": "

Value indicates exporting metrics related to the behavior when it is true.

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

Cancels a mitigation action task that is in progress. If the task\n is not\n in progress, an InvalidRequestException occurs.

\n

Requires permission to access the CancelAuditMitigationActionsTask action.

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

Cancels a mitigation action task that is in progress. If the task is not in progress, an\n InvalidRequestException occurs.

\n

Requires permission to access the CancelAuditMitigationActionsTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/mitigationactions/tasks/{taskId}/cancel", @@ -4903,7 +4909,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an \"InvalidRequestException\" occurs.

\n

Requires permission to access the CancelAuditTask action.

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

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If\n the audit isn't in progress, an \"InvalidRequestException\" occurs.

\n

Requires permission to access the CancelAuditTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/tasks/{taskId}/cancel", @@ -4917,7 +4923,7 @@ "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "

The ID of the audit you want to cancel. You can only cancel an\n audit that is \"IN_PROGRESS\".

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

The ID of the audit you want to cancel. You can only cancel an audit that is\n \"IN_PROGRESS\".

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

\n Cancels a Device Defender ML Detect mitigation action.\n

\n

Requires permission to access the CancelDetectMitigationActionsTask action.

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

Cancels a Device Defender ML Detect mitigation action.

\n

Requires permission to access the CancelDetectMitigationActionsTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}/cancel", @@ -5028,7 +5034,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the task.\n

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

The unique identifier of the task.

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

Use this API to define a\n Custom\n Metric\n published by your devices to Device Defender.

\n

Requires permission to access the CreateCustomMetric action.

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

Use this API to define a Custom Metric published by your devices to Device Defender.

\n

Requires permission to access the CreateCustomMetric action.

", "smithy.api#http": { "method": "POST", "uri": "/custom-metric/{metricName}", @@ -6569,13 +6575,13 @@ "tags": { "target": "com.amazonaws.iot#TagList", "traits": { - "smithy.api#documentation": "

\n Metadata that can be used to manage the custom metric.\n

" + "smithy.api#documentation": "

Metadata that can be used to manage the custom metric.

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each custom\n metric must have a unique client request token. If you try to create a new custom metric that\n already exists with a different token,\n an exception\n occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

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

Each custom metric must have a unique client request token. If you try to create a new\n custom metric that already exists with a different token, an exception occurs. If you omit\n this value, Amazon Web Services SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -6591,7 +6597,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

\n The name of the custom metric to be used in the metric report.\n

" + "smithy.api#documentation": "

The name of the custom metric to be used in the metric report.

" } }, "metricArn": { @@ -6631,7 +6637,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. \n For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

\n

Requires permission to access the CreateDimension action.

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

Create a dimension that you can use to limit the scope of a metric used in a security\n profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow\n down the scope of the metric only to MQTT topics whose name match the pattern specified in the\n dimension.

\n

Requires permission to access the CreateDimension action.

", "smithy.api#http": { "method": "POST", "uri": "/dimensions/{name}", @@ -6645,7 +6651,7 @@ "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

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

A unique identifier for the dimension. Choose something that describes the type and value\n to make it easy to remember what it does.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6660,7 +6666,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

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

Specifies the value or list of values for the dimension. For TOPIC_FILTER\n dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } }, @@ -6673,7 +6679,7 @@ "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. \n If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

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

Each dimension must have a unique client request token. If you try to create a new\n dimension with the same token as a dimension that already exists, an exception occurs. If you\n omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -6695,7 +6701,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name\n (ARN)\n of\n the created dimension.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created dimension.

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

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. \n For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

\n

Requires permission to access the CreateMitigationAction action.

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

Defines an action that can be applied to audit findings by using\n StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to\n specific check names. For more information, see Mitigation\n actions. Each mitigation action can apply only one type of change.

\n

Requires permission to access the CreateMitigationAction action.

", "smithy.api#http": { "method": "POST", "uri": "/mitigationactions/actions/{actionName}", @@ -7535,7 +7541,7 @@ "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

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

A friendly name for the action. Choose a friendly name that accurately describes the\n action (for example, EnableLoggingAction).

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

Creates a scheduled audit that is run at a specified \n time interval.

\n

Requires permission to access the CreateScheduledAudit action.

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

Creates a scheduled audit that is run at a specified time interval.

\n

Requires permission to access the CreateScheduledAudit action.

", "smithy.api#http": { "method": "POST", "uri": "/audit/scheduledaudits/{scheduledAuditName}", @@ -8648,26 +8654,26 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes\n place, either\n DAILY,\n WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is\n determined by the system.

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

How often the scheduled audit takes place, either DAILY, WEEKLY,\n BIWEEKLY or MONTHLY. The start time of each audit is determined by\n the system.

", "smithy.api#required": {} } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This\n can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\"\n parameter is set to MONTHLY. If days\n 29\n to 31 are specified, and the month\n doesn't\n have that many days, the audit takes place on the LAST day of the month.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. This can be \"1\" through\n \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to\n MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many\n days, the audit takes place on the LAST day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes\n place,\n either\n SUN,\n MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency\n parameter is set to WEEKLY or BIWEEKLY.

" + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place, either SUN,\n MON, TUE, WED, THU, FRI, or\n SAT. This field is required if the frequency parameter is set to\n WEEKLY or BIWEEKLY.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

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

Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)

", "smithy.api#required": {} } }, @@ -8755,13 +8761,13 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { - "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the \n console.) Alerts are generated when a device (thing) violates a behavior.

" + "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the\n console.) Alerts are generated when a device (thing) violates a behavior.

" } }, "additionalMetricsToRetain": { @@ -8770,13 +8776,13 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "tags": { @@ -8784,6 +8790,12 @@ "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the security profile.

" } + }, + "metricsExportConfig": { + "target": "com.amazonaws.iot#MetricsExportConfig", + "traits": { + "smithy.api#documentation": "

Specifies the MQTT topic and role ARN required for metric export.

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

Create a thing group.

\n \n

This is a control plane operation. See Authorization for\n\t\t\t\tinformation about authorizing control plane actions.

\n \n

Requires permission to access the CreateThingGroup action.

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

Create a thing group.

\n \n

This is a control plane operation. See Authorization for\n\t\t\t\tinformation about authorizing control plane actions.

\n

If the ThingGroup that you create has the exact same attributes as an existing\n\t\t\t\t\tThingGroup, you will get a 200 success response.\n\t\t\t

\n \n

Requires permission to access the CreateThingGroup action.

", "smithy.api#http": { "method": "POST", "uri": "/thing-groups/{thingGroupName}", @@ -9539,7 +9551,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to \n disabled.

\n

Requires permission to access the DeleteAccountAuditConfiguration action.

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

Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to disabled.\n \n

\n

Requires permission to access the DeleteAccountAuditConfiguration action.

", "smithy.api#http": { "method": "DELETE", "uri": "/audit/configuration", @@ -9936,7 +9948,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Deletes a Device Defender detect custom metric.\n

\n

Requires permission to access the DeleteCustomMetric action.

\n \n

Before you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of.\n The\n security\n profile associated with the custom metric can be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.

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

Deletes a Device Defender detect custom metric.

\n

Requires permission to access the DeleteCustomMetric action.

\n \n

Before you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of. The security profile associated with the custom metric can\n be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/custom-metric/{metricName}", @@ -9950,7 +9962,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

\n The name of the custom metric.\n

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

The name of the custom metric.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10395,6 +10407,12 @@ "smithy.api#input": {} } }, + "com.amazonaws.iot#DeleteMetricsExportConfig": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.iot#DeleteMitigationAction": { "type": "operation", "input": { @@ -11127,7 +11145,7 @@ "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { - "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

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

The expected version of the security profile. A new version is generated whenever the\n security profile is updated. If you specify a value that is different from the actual version,\n a VersionConflictException is thrown.

", "smithy.api#httpQuery": "expectedVersion" } } @@ -11679,7 +11697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.

\n

Requires permission to access the DescribeAccountAuditConfiguration action.

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

Gets information about the Device Defender audit settings for this account. Settings\n include how audit notifications are sent and which audit checks are enabled or\n disabled.

\n

Requires permission to access the DescribeAccountAuditConfiguration action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/configuration", @@ -11700,13 +11718,13 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the role that grants permission to IoT to access information\n about your devices, policies, certificates, and other items as required when \n performing an audit.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required.

" + "smithy.api#documentation": "

The ARN of the role that grants permission to IoT to access information about your\n devices, policies, certificates, and other items as required when performing an audit.

\n

On the first call to UpdateAccountAuditConfiguration, this parameter is\n required.

" } }, "auditNotificationTargetConfigurations": { "target": "com.amazonaws.iot#AuditNotificationTargetConfigurations", "traits": { - "smithy.api#documentation": "

Information about the targets to which audit notifications are sent for \n this account.

" + "smithy.api#documentation": "

Information about the targets to which audit notifications are sent for this\n account.

" } }, "auditCheckConfigurations": { @@ -11743,7 +11761,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue,\n and the start time\n when the audit that returned the\n finding.

\n

Requires permission to access the DescribeAuditFinding action.

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

Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue, and the start time when the audit that returned the\n finding.

\n

Requires permission to access the DescribeAuditFinding action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/findings/{findingId}", @@ -11757,7 +11775,7 @@ "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

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

A unique identifier for a single audit finding. You can use this identifier to apply\n mitigation actions to the finding.

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

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

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

Gets information about an audit mitigation task that is used to apply mitigation actions\n to a set of audit findings. Properties include the actions being applied, the audit checks to\n which they're being applied, the task status, and aggregated task statistics.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/tasks/{taskId}", @@ -11849,13 +11867,13 @@ "taskStatistics": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatistics", "traits": { - "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

" + "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for\n this audit mitigation actions task.

" } }, "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

" + "smithy.api#documentation": "

Identifies the findings to which the mitigation actions are applied. This can be by audit\n checks, by audit task, or a set of findings.

" } }, "auditCheckToActionsMapping": { @@ -11867,7 +11885,7 @@ "actionsDefinition": { "target": "com.amazonaws.iot#MitigationActionList", "traits": { - "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this task.

" + "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this\n task.

" } } }, @@ -12011,7 +12029,7 @@ "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" + "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or\n \"CANCELED\".

" } }, "taskType": { @@ -12375,7 +12393,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Gets information about a Device Defender detect custom metric.\n

\n

Requires permission to access the DescribeCustomMetric action.

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

Gets information about a Device Defender detect custom metric.

\n

Requires permission to access the DescribeCustomMetric action.

", "smithy.api#http": { "method": "GET", "uri": "/custom-metric/{metricName}", @@ -12389,7 +12407,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

\n The name of the custom metric.\n

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

The name of the custom metric.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12405,37 +12423,37 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

\n The name of the custom metric.\n

" + "smithy.api#documentation": "

The name of the custom metric.

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric.\n

" + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the custom metric.

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { - "smithy.api#documentation": "

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

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

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while\n submitting the metrics value in the DeviceMetrics report, it must be passed as an array with\n a single value.

\n " } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "

\n Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.\n

" + "smithy.api#documentation": "

Field represents a friendly name in the console for the custom metric; doesn't have to be\n unique. Don't use this name as the metric identifier in the device metric report. Can be\n updated.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n The creation date of the custom metric in milliseconds since epoch.\n

" + "smithy.api#documentation": "

The creation date of the custom metric in milliseconds since epoch.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time the custom metric was last modified in milliseconds since epoch.\n

" + "smithy.api#documentation": "

The time the custom metric was last modified in milliseconds since epoch.

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

\n Gets information about a Device Defender ML Detect mitigation action.\n

\n

Requires permission to access the DescribeDetectMitigationActionsTask action.

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

Gets information about a Device Defender ML Detect mitigation action.

\n

Requires permission to access the DescribeDetectMitigationActionsTask action.

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks/{taskId}", @@ -12538,7 +12556,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the task.\n

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

The unique identifier of the task.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12554,7 +12572,7 @@ "taskSummary": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummary", "traits": { - "smithy.api#documentation": "

\n The description of a task.\n

" + "smithy.api#documentation": "

The description of a task.

" } } }, @@ -12621,7 +12639,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name\n (ARN)\n for\n the dimension.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the dimension.

" } }, "type": { @@ -12633,7 +12651,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" + "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters,\n this is the pattern used to match the MQTT topic name.

" } }, "creationDate": { @@ -13564,7 +13582,7 @@ "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { - "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

" + "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of\n mitigation action.

" } }, "creationDate": { @@ -13920,25 +13938,25 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes\n place, either\n one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.

" + "smithy.api#documentation": "

How often the scheduled audit takes place, either one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each\n audit is determined by the system.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This is\n will be 1\n through 31 or LAST. If days\n 29-31\n are specified, and the month does not have that many days, the audit takes place on the LAST\n day of the month.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. This is will be\n 1 through 31 or LAST. If days\n 29-31 are specified, and the month does not have that many days,\n the audit takes place on the LAST day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes\n place,\n either one of\n SUN, MON, TUE, WED, THU, FRI, or SAT.

" + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place, either one of\n SUN, MON, TUE, WED, THU,\n FRI, or SAT.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be \n enabled for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)

" } }, "scheduledAuditName": { @@ -13995,7 +14013,7 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

The name of the security profile\n whose information you want to get.

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

The name of the security profile whose information you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14023,13 +14041,13 @@ "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { - "smithy.api#documentation": "

A description of the security profile (associated with the security profile\n when it was created or updated).

" + "smithy.api#documentation": "

A description of the security profile (associated with the security profile when it was\n created or updated).

" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" } }, "alertTargets": { @@ -14044,20 +14062,20 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use\n DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here.

" + "smithy.api#documentation": "

\n Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but\n it is\n also retained for any metric specified here.

" + "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified\n here.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the\n security profile is updated.

" + "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the security\n profile is updated.

" } }, "creationDate": { @@ -14071,6 +14089,12 @@ "traits": { "smithy.api#documentation": "

The time the security profile was last modified.

" } + }, + "metricsExportConfig": { + "target": "com.amazonaws.iot#MetricsExportConfig", + "traits": { + "smithy.api#documentation": "

Specifies the MQTT topic and role ARN required for metric export.

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

Disassociates a Device Defender security profile from a thing group or from this account.

\n

Requires permission to access the DetachSecurityProfile action.

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

Disassociates a Device Defender security profile from a thing group or from this\n account.

\n

Requires permission to access the DetachSecurityProfile action.

", "smithy.api#http": { "method": "DELETE", "uri": "/security-profiles/{securityProfileName}/targets", @@ -16018,6 +16042,9 @@ "smithy.api#documentation": "

Allows you to create an exponential rate of rollout for a job.

" } }, + "com.amazonaws.iot#ExportMetric": { + "type": "boolean" + }, "com.amazonaws.iot#FailedChecksCount": { "type": "integer" }, @@ -16466,7 +16493,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a Device Defender's ML Detect Security Profile training model's status.\n

\n

Requires permission to access the GetBehaviorModelTrainingSummaries action.

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

Returns a Device Defender's ML Detect Security Profile training model's status.

\n

Requires permission to access the GetBehaviorModelTrainingSummaries action.

", "smithy.api#http": { "method": "GET", "uri": "/behavior-model-training/summaries", @@ -16486,21 +16513,21 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

\n The name of the security profile.\n

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

The name of the security profile.

", "smithy.api#httpQuery": "securityProfileName" } }, "maxResults": { "target": "com.amazonaws.iot#TinyMaxResults", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 10.\n

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

The maximum number of results to return at one time. The default is 10.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results.\n

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

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -16515,13 +16542,13 @@ "summaries": { "target": "com.amazonaws.iot#BehaviorModelTrainingSummaries", "traits": { - "smithy.api#documentation": "

\n A list of all ML Detect behaviors and their model status for a given Security Profile.\n

" + "smithy.api#documentation": "

A list of all ML Detect behaviors and their model status for a given Security Profile.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" } } }, @@ -19633,14 +19660,14 @@ "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { - "smithy.api#documentation": "

\n The criteria for a behavior.\n

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

The criteria for a behavior.

", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { - "smithy.api#documentation": "

\n A list of all suppressed alerts.\n

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

A list of all suppressed alerts.

", "smithy.api#httpQuery": "listSuppressedAlerts" } }, @@ -19682,7 +19709,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

Lists the findings (results) of a Device Defender audit or of the audits\n performed during a specified time period. (Findings are retained for 90 days.)

\n

Requires permission to access the ListAuditFindings action.

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

Lists the findings (results) of a Device Defender audit or of the audits performed during\n a specified time period. (Findings are retained for 90 days.)

\n

Requires permission to access the ListAuditFindings action.

", "smithy.api#http": { "method": "POST", "uri": "/audit/findings", @@ -19834,7 +19861,7 @@ "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "

A filter to limit results to the audit with the specified ID. You must\n specify either the taskId or the startTime and endTime, but not both.

" + "smithy.api#documentation": "

A filter to limit results to the audit with the specified ID. You must specify either the\n taskId or the startTime and endTime, but not both.

" } }, "checkName": { @@ -19864,13 +19891,13 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" + "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must specify either\n the startTime and endTime or the taskId, but not both.

" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" + "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.

" } }, "listSuppressedFindings": { @@ -19897,7 +19924,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

Gets the status of audit mitigation action tasks that were\n executed.

\n

Requires permission to access the ListAuditMitigationActionsExecutions action.

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

Gets the status of audit mitigation action tasks that were executed.

\n

Requires permission to access the ListAuditMitigationActionsExecutions action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/executions", @@ -19945,7 +19972,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to actions for a specific audit mitigation actions task.

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

Specify this filter to limit results to actions for a specific audit mitigation actions\n task.

", "smithy.api#httpQuery": "taskId", "smithy.api#required": {} } @@ -19960,7 +19987,7 @@ "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to those that were applied to a specific audit finding.

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

Specify this filter to limit results to those that were applied to a specific audit\n finding.

", "smithy.api#httpQuery": "findingId", "smithy.api#required": {} } @@ -19990,7 +20017,7 @@ "actionsExecutions": { "target": "com.amazonaws.iot#AuditMitigationActionExecutionMetadataList", "traits": { - "smithy.api#documentation": "

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

" + "smithy.api#documentation": "

A set of task execution results based on the input parameters. Details include the\n mitigation action applied, start time, and task status.

" } }, "nextToken": { @@ -20044,14 +20071,14 @@ "auditTaskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to results for a specific audit.

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

Specify this filter to limit results to tasks that were applied to results for a specific\n audit.

", "smithy.api#httpQuery": "auditTaskId" } }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to a specific audit finding.

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

Specify this filter to limit results to tasks that were applied to a specific audit\n finding.

", "smithy.api#httpQuery": "findingId" } }, @@ -20079,7 +20106,7 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that began on or after a specific date and time.

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

Specify this filter to limit results to tasks that began on or after a specific date and\n time.

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -20087,7 +20114,7 @@ "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

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

Specify this filter to limit results to tasks that were completed or canceled on or before\n a specific date and time.

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } @@ -20224,7 +20251,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Device Defender audits that have been performed during a given\n time period.

\n

Requires permission to access the ListAuditTasks action.

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

Lists the Device Defender audits that have been performed during a given time\n period.

\n

Requires permission to access the ListAuditTasks action.

", "smithy.api#http": { "method": "GET", "uri": "/audit/tasks", @@ -20244,7 +20271,7 @@ "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The beginning of the time period. Audit information is retained for a \n limited time (90 days). Requesting a start time prior to what is retained \n results in an \"InvalidRequestException\".

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

The beginning of the time period. Audit information is retained for a limited time (90\n days). Requesting a start time prior to what is retained results in an\n \"InvalidRequestException\".

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -20260,14 +20287,14 @@ "taskType": { "target": "com.amazonaws.iot#AuditTaskType", "traits": { - "smithy.api#documentation": "

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

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

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", "smithy.api#httpQuery": "taskType" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { - "smithy.api#documentation": "

A filter to limit the output to audits with the specified completion\n status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

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

A filter to limit the output to audits with the specified completion status: can be one of\n \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", "smithy.api#httpQuery": "taskStatus" } }, @@ -20302,7 +20329,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

\n Lists your Device Defender detect custom metrics.\n

\n

Requires permission to access the ListCustomMetrics action.

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

Lists your Device Defender detect custom metrics.

\n

Requires permission to access the ListCustomMetrics action.

", "smithy.api#http": { "method": "GET", "uri": "/custom-metrics", @@ -20824,14 +20851,14 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results.\n

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

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

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

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } } @@ -20846,13 +20873,13 @@ "metricNames": { "target": "com.amazonaws.iot#MetricNames", "traits": { - "smithy.api#documentation": "

\n The name of the custom metric.\n

" + "smithy.api#documentation": "

The name of the custom metric.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, \n or null if there are no additional results.\n

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

\n Lists mitigation actions executions for a Device Defender ML Detect Security Profile.\n

\n

Requires permission to access the ListDetectMitigationActionsExecutions action.

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

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

\n

Requires permission to access the ListDetectMitigationActionsExecutions action.

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/executions", @@ -20900,49 +20927,49 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the task.\n

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

The unique identifier of the task.

", "smithy.api#httpQuery": "taskId" } }, "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the violation.\n

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

The unique identifier of the violation.

", "smithy.api#httpQuery": "violationId" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { - "smithy.api#documentation": "

\n The name of the thing whose mitigation actions are listed.\n

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

The name of the thing whose mitigation actions are listed.

", "smithy.api#httpQuery": "thingName" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n

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

A filter to limit results to those found after the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.

", "smithy.api#httpQuery": "startTime" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n The end of the time period for which ML Detect mitigation actions executions are returned.\n

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

The end of the time period for which ML Detect mitigation actions executions are\n returned.

", "smithy.api#httpQuery": "endTime" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { - "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

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

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results.\n

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

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -20957,13 +20984,13 @@ "actionsExecutions": { "target": "com.amazonaws.iot#DetectMitigationActionExecutionList", "traits": { - "smithy.api#documentation": "

\n List of actions executions.\n

" + "smithy.api#documentation": "

List of actions executions.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

\n List of Device Defender ML Detect mitigation actions tasks.\n

\n

Requires permission to access the ListDetectMitigationActionsTasks action.

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

List of Device Defender ML Detect mitigation actions tasks.

\n

Requires permission to access the ListDetectMitigationActionsTasks action.

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks", @@ -21018,14 +21045,14 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n The token for the next set of results.\n

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

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n

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

A filter to limit results to those found after the specified time. You must specify\n either the startTime and endTime or the taskId, but not both.

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } @@ -21033,7 +21060,7 @@ "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n The end of the time period for which ML Detect mitigation actions tasks are returned.\n

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

The end of the time period for which ML Detect mitigation actions tasks are returned.\n

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } @@ -21049,13 +21076,13 @@ "tasks": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummaryList", "traits": { - "smithy.api#documentation": "

\n The collection of ML Detect mitigation tasks that matched the filter criteria.\n

" + "smithy.api#documentation": "

The collection of ML Detect mitigation tasks that matched the filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" } } }, @@ -21125,13 +21152,13 @@ "dimensionNames": { "target": "com.amazonaws.iot#DimensionNames", "traits": { - "smithy.api#documentation": "

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

" + "smithy.api#documentation": "

A list of the names of the defined dimensions. Use DescribeDimension to get\n details for a dimension.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) \n by the given thing during the specified time period.

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

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric,\n or custom metric) by the given thing during the specified time period.

", "smithy.api#http": { "method": "GET", "uri": "/metric-values", @@ -21987,7 +22014,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" } } }, @@ -22035,7 +22062,7 @@ "actionType": { "target": "com.amazonaws.iot#MitigationActionType", "traits": { - "smithy.api#documentation": "

Specify a value to limit the result to mitigation actions with a specific action type.

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

Specify a value to limit the result to mitigation actions with a specific action\n type.

", "smithy.api#httpQuery": "actionType" } }, @@ -23082,7 +23109,7 @@ } ], "traits": { - "smithy.api#documentation": "

The related resources of an Audit finding. \n The following resources can be returned from calling this API:

\n \n \n

This API is similar to DescribeAuditFinding's RelatedResources \n but provides pagination and is not limited to 10 resources. \n When calling DescribeAuditFinding for the intermediate CA revoked for \n active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

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

The related resources of an Audit finding. The following resources can be returned from\n calling this API:

\n \n \n

This API is similar to DescribeAuditFinding's RelatedResources but\n provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device\n certificates check, RelatedResources will not be populated. You must use this API,\n ListRelatedResourcesForAuditFinding, to list the certificates.

\n ", "smithy.api#http": { "method": "GET", "uri": "/audit/relatedResources", @@ -23110,7 +23137,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

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

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -23138,7 +23165,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null for the first API call.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null for the\n first API call.

" } } }, @@ -23304,7 +23331,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

Lists the Device Defender security profiles\n you've\n created. You can filter security profiles by dimension or custom metric.

\n

Requires permission to access the ListSecurityProfiles action.

\n \n

\n dimensionName and metricName cannot be used in the same request.

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

Lists the Device Defender security profiles you've created. You can filter security\n profiles by dimension or custom metric.

\n

Requires permission to access the ListSecurityProfiles action.

\n \n

\n dimensionName and metricName cannot be used in the same\n request.

\n ", "smithy.api#http": { "method": "GET", "uri": "/security-profiles", @@ -23414,7 +23441,7 @@ "securityProfileTargetArn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { - "smithy.api#documentation": "

The ARN of the target (thing group) whose attached security profiles you want to get.

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

The ARN of the target (thing group) whose attached security profiles you want to\n get.

", "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } @@ -23436,7 +23463,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

" } } }, @@ -23464,14 +23491,14 @@ "dimensionName": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

A filter to limit results to the security profiles that use the defined dimension.\n Cannot be used with metricName\n

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

A filter to limit results to the security profiles that use the defined dimension. Cannot\n be used with metricName\n

", "smithy.api#httpQuery": "dimensionName" } }, "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric.\n Cannot be used with dimensionName.

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

The name of the custom metric. Cannot be used with dimensionName.

", "smithy.api#httpQuery": "metricName" } } @@ -23492,7 +23519,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

Lists the targets (thing groups) associated with a given Device Defender security profile.

\n

Requires permission to access the ListTargetsForSecurityProfile action.

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

Lists the targets (thing groups) associated with a given Device Defender security\n profile.

\n

Requires permission to access the ListTargetsForSecurityProfile action.

", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{securityProfileName}/targets", @@ -23853,7 +23880,7 @@ "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

Lists the Device Defender security profile violations discovered during the given time period. \n You can use filters to limit the results to those alerts issued for a particular security profile, \n behavior, or thing (device).

\n

Requires permission to access the ListViolationEvents action.

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

Lists the Device Defender security profile violations discovered during the given time\n period. You can use filters to limit the results to those alerts issued for a particular\n security profile, behavior, or thing (device).

\n

Requires permission to access the ListViolationEvents action.

", "smithy.api#http": { "method": "GET", "uri": "/violation-events", @@ -25036,21 +25063,21 @@ "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { - "smithy.api#documentation": "

A filter to limit results to those alerts generated by the specified security profile.

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

A filter to limit results to those alerts generated by the specified security\n profile.

", "smithy.api#httpQuery": "securityProfileName" } }, "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { - "smithy.api#documentation": "

\n The criteria for a behavior.\n

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

The criteria for a behavior.

", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { - "smithy.api#documentation": "

\n A list of all suppressed alerts.\n

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

A list of all suppressed alerts.

", "smithy.api#httpQuery": "listSuppressedAlerts" } }, @@ -25086,13 +25113,13 @@ "violationEvents": { "target": "com.amazonaws.iot#ViolationEvents", "traits": { - "smithy.api#documentation": "

The security profile violation alerts issued for this account during the given time period, \n potentially filtered by security profile, behavior violated, or thing (device) violating.

" + "smithy.api#documentation": "

The security profile violation alerts issued for this account during the given time\n period, potentially filtered by security profile, behavior violated, or thing (device)\n violating.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" + "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if\n there are no additional results.

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

The dimension of a metric. This can't be used with custom metrics.

" } + }, + "exportMetric": { + "target": "com.amazonaws.iot#ExportMetric", + "traits": { + "smithy.api#documentation": "

Value added in both Behavior and AdditionalMetricsToRetainV2 to indicate if Device\n Defender Detect should export the corresponding metrics.

" + } } }, "traits": { @@ -25668,6 +25701,28 @@ "smithy.api#documentation": "

The value to be compared with the metric.

" } }, + "com.amazonaws.iot#MetricsExportConfig": { + "type": "structure", + "members": { + "mqttTopic": { + "target": "com.amazonaws.iot#MqttTopic", + "traits": { + "smithy.api#documentation": "

The MQTT topic that Device Defender Detect should publish messages to for metrics\n export.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", + "traits": { + "smithy.api#documentation": "

This role ARN has permission to publish MQTT messages, after which Device Defender Detect\n can assume the role and publish messages on your behalf.

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

Set configurations for metrics export.

" + } + }, "com.amazonaws.iot#Minimum": { "type": "double", "traits": { @@ -25996,6 +26051,15 @@ } } }, + "com.amazonaws.iot#MqttTopic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, "com.amazonaws.iot#MqttUsername": { "type": "string", "traits": { @@ -29056,7 +29120,7 @@ "maxResults": { "target": "com.amazonaws.iot#QueryMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return at one time.

" + "smithy.api#documentation": "

The maximum number of results to return at one time. The response might contain fewer results but will never contain more.

" } }, "queryVersion": { @@ -29875,7 +29939,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

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

A unique identifier for the task. You can use this identifier to check the status of the\n task or to cancel it.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29883,21 +29947,21 @@ "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a\n specific set of\n findings.

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

Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a specific set of\n findings.

", "smithy.api#required": {} } }, "auditCheckToActionsMapping": { "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { - "smithy.api#documentation": "

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

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

For an audit check, specifies which mitigation actions to apply. Those actions must be\n defined in your Amazon Web Services accounts.

", "smithy.api#required": {} } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

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

Each audit mitigation task must have a unique client request token. If you try to start a\n new task with the same token as a task that already exists, an exception occurs. If you omit\n this value, a unique client request token is generated automatically.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -29913,7 +29977,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

" + "smithy.api#documentation": "

The unique identifier for the audit mitigation task. This matches the taskId\n that you specified in the request.

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

\n Starts a Device Defender ML Detect mitigation actions task.\n

\n

Requires permission to access the StartDetectMitigationActionsTask action.

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

Starts a Device Defender ML Detect mitigation actions task.

\n

Requires permission to access the StartDetectMitigationActionsTask action.

", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}", @@ -29961,7 +30025,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the task.\n

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

The unique identifier of the task.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -29969,39 +30033,39 @@ "target": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskTarget", "traits": { - "smithy.api#documentation": "

\n Specifies the ML Detect findings to which the mitigation actions are applied.\n

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

Specifies the ML Detect findings to which the mitigation actions are applied.

", "smithy.api#required": {} } }, "actions": { "target": "com.amazonaws.iot#DetectMitigationActionsToExecuteList", "traits": { - "smithy.api#documentation": "

\n The actions to be performed when a device has unexpected behavior.\n

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

The actions to be performed when a device has unexpected behavior.

", "smithy.api#required": {} } }, "violationEventOccurrenceRange": { "target": "com.amazonaws.iot#ViolationEventOccurrenceRange", "traits": { - "smithy.api#documentation": "

\n Specifies the time period of which violation events occurred between.\n

" + "smithy.api#documentation": "

Specifies the time period of which violation events occurred between.

" } }, "includeOnlyActiveViolations": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { - "smithy.api#documentation": "

\n Specifies to list only active violations.\n

" + "smithy.api#documentation": "

Specifies to list only active violations.

" } }, "includeSuppressedAlerts": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { - "smithy.api#documentation": "

\n Specifies to include suppressed alerts.\n

" + "smithy.api#documentation": "

Specifies to include suppressed alerts.

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { - "smithy.api#documentation": "

\n Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.\n

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

Each mitigation action task must have a unique client request token. If you try to create\n a new task with the same token as a task that already exists, an exception occurs. If you omit\n this value, Amazon Web Services SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -30017,7 +30081,7 @@ "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { - "smithy.api#documentation": "

\n The unique identifier of the task.\n

" + "smithy.api#documentation": "

The unique identifier of the task.

" } } }, @@ -30062,7 +30126,7 @@ "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the audit. The checks you specify must be enabled \n for your account or an exception occurs. Use DescribeAccountAuditConfiguration \n to see the list of all checks, including those that are enabled or \n UpdateAccountAuditConfiguration to select which checks are enabled.

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

Which checks are performed during the audit. The checks you specify must be enabled for\n your account or an exception occurs. Use DescribeAccountAuditConfiguration to see\n the list of all checks, including those that are enabled or\n UpdateAccountAuditConfiguration to select which checks are enabled.

", "smithy.api#required": {} } } @@ -31481,7 +31545,7 @@ "managedFields": { "target": "com.amazonaws.iot#Fields", "traits": { - "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.

" + "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.

\n \n

You can't modify managed fields by updating fleet indexing configuration.

\n " } }, "customFields": { @@ -31632,7 +31696,7 @@ "managedFields": { "target": "com.amazonaws.iot#Fields", "traits": { - "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service.

" + "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.

\n \n

You can't modify managed fields by updating fleet indexing configuration.

\n " } }, "customFields": { @@ -32633,7 +32697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures or reconfigures the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.

\n

Requires permission to access the UpdateAccountAuditConfiguration action.

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

Configures or reconfigures the Device Defender audit settings for this account. Settings\n include how audit notifications are sent and which audit checks are enabled or\n disabled.

\n

Requires permission to access the UpdateAccountAuditConfiguration action.

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/configuration", @@ -32647,7 +32711,7 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon\n Resource Name\n (ARN)\n of the role that grants permission\n to\n IoT to access information about your devices, policies,\n certificates,\n and other items as required when performing an audit.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access\n information about your devices, policies, certificates, and other items as required when\n performing an audit.

" } }, "auditNotificationTargetConfigurations": { @@ -32659,7 +32723,7 @@ "auditCheckConfigurations": { "target": "com.amazonaws.iot#AuditCheckConfigurations", "traits": { - "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use \n DescribeAccountAuditConfiguration to see the list of all checks, including those \n that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. \n When a check is disabled, any data collected so far in relation to the check is deleted.

\n

You\n cannot\n disable a check if\n it's\n used by any scheduled audit. You must first delete the check from the scheduled audit or\n delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required and must specify at least one enabled check.

" + "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use\n DescribeAccountAuditConfiguration to see the list of all checks, including\n those that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. When a check\n is disabled, any data collected so far in relation to the check is deleted.

\n

You cannot disable a check if it's used by any scheduled audit. You must first delete the\n check from the scheduled audit or delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration, this parameter is\n required and must specify at least one enabled check.

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

Updates a\n Device Defender detect custom metric.

\n

Requires permission to access the UpdateCustomMetric action.

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

Updates a Device Defender detect custom metric.

\n

Requires permission to access the UpdateCustomMetric action.

", "smithy.api#http": { "method": "PATCH", "uri": "/custom-metric/{metricName}", @@ -33132,7 +33196,7 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

The name of the custom metric.\n Cannot be updated.

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

The name of the custom metric. Cannot be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33140,7 +33204,7 @@ "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "

\n Field\n represents a friendly name in the console for the custom metric,\n it\n doesn't have to be unique. Don't use this name as the metric identifier in\n the device metric report.\n Can\n be updated.

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

Field represents a friendly name in the console for the custom metric, it doesn't have to\n be unique. Don't use this name as the metric identifier in the device metric report. Can be\n updated.

", "smithy.api#required": {} } } @@ -33155,37 +33219,37 @@ "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { - "smithy.api#documentation": "

\n The name of the custom metric.\n

" + "smithy.api#documentation": "

The name of the custom metric.

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric.\n

" + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the custom metric.

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { - "smithy.api#documentation": "

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

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

The type of the custom metric.

\n \n

The type number only takes a single metric value as an input, but while\n submitting the metrics value in the DeviceMetrics report, it must be passed as an array with\n a single value.

\n " } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { - "smithy.api#documentation": "

\n A friendly name in the console for the custom metric\n

" + "smithy.api#documentation": "

A friendly name in the console for the custom metric

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n The creation date of the custom metric in milliseconds since epoch.\n

" + "smithy.api#documentation": "

The creation date of the custom metric in milliseconds since epoch.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

\n The time the custom metric was last modified in milliseconds since epoch.\n

" + "smithy.api#documentation": "

The time the custom metric was last modified in milliseconds since epoch.

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

Updates the definition for a dimension. You\n cannot\n change the type of a dimension after\n it is created (you can delete it and\n recreate\n it).

\n

Requires permission to access the UpdateDimension action.

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

Updates the definition for a dimension. You cannot change the type of a dimension after it\n is created (you can delete it and recreate it).

\n

Requires permission to access the UpdateDimension action.

", "smithy.api#http": { "method": "PATCH", "uri": "/dimensions/{name}", @@ -33245,7 +33309,7 @@ "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { - "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

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

A unique identifier for the dimension. Choose something that describes the type and value\n to make it easy to remember what it does.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -33253,7 +33317,7 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

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

Specifies the value or list of values for the dimension. For TOPIC_FILTER\n dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } } @@ -33274,7 +33338,7 @@ "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource\n Name (ARN)of\n the created dimension.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN)of the created dimension.

" } }, "type": { @@ -33286,19 +33350,19 @@ "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { - "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" + "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters,\n this is the pattern used to match the MQTT topic name.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially created.

" + "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially\n created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

" + "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently\n updated.

" } } }, @@ -33863,7 +33927,7 @@ "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { - "smithy.api#documentation": "

The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and\n recreate the\n mitigation action with the new name.

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

The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and recreate the mitigation\n action with the new name.

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

Updates a scheduled audit, including which checks are performed and\n how often the audit takes place.

\n

Requires permission to access the UpdateScheduledAudit action.

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

Updates a scheduled audit, including which checks are performed and how often the audit\n takes place.

\n

Requires permission to access the UpdateScheduledAudit action.

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/scheduledaudits/{scheduledAuditName}", @@ -34349,25 +34413,25 @@ "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { - "smithy.api#documentation": "

How often the scheduled audit takes\n place,\n either DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.

" + "smithy.api#documentation": "

How often the scheduled audit takes place, either DAILY, WEEKLY,\n BIWEEKLY, or MONTHLY. The start time of each audit is determined\n by the system.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This\n can\n be 1 through 31 or LAST. This field is required if the frequency parameter is set to\n MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit\n takes place on the \"LAST\" day of the month.

" + "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place. This can be 1\n through 31 or LAST. This field is required if the\n frequency parameter is set to MONTHLY. If days 29-31 are\n specified, and the month does not have that many days, the audit takes place on the \"LAST\" day\n of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place.\n This\n can\n be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the\n \"frequency\" parameter is set to WEEKLY or BIWEEKLY.

" + "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place. This can be one of\n SUN, MON, TUE, WED, THU,\n FRI, or SAT. This field is required if the \"frequency\" parameter\n is set to WEEKLY or BIWEEKLY.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { - "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" + "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled for your\n account. (Use DescribeAccountAuditConfiguration to see the list of all checks,\n including those that are enabled or use UpdateAccountAuditConfiguration to select\n which checks are enabled.)

" } }, "scheduledAuditName": { @@ -34451,7 +34515,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" } }, "alertTargets": { @@ -34466,42 +34530,55 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use\n UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

\n Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric\n specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified here.\n Can be used with custom metrics; cannot be used with dimensions.

" } }, "deleteBehaviors": { "target": "com.amazonaws.iot#DeleteBehaviors", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. \n If any behaviors are defined in the current invocation, an exception occurs.

" + "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. If any\n behaviors are defined in the current invocation, an exception occurs.

" } }, "deleteAlertTargets": { "target": "com.amazonaws.iot#DeleteAlertTargets", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. \n If any alertTargets are defined in the current invocation, an exception occurs.

" + "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. If any\n alertTargets are defined in the current invocation, an exception\n occurs.

" } }, "deleteAdditionalMetricsToRetain": { "target": "com.amazonaws.iot#DeleteAdditionalMetricsToRetain", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If true, delete all additionalMetricsToRetain defined for this \n security profile. If any additionalMetricsToRetain are defined in the current \n invocation, an exception occurs.

" + "smithy.api#documentation": "

If true, delete all additionalMetricsToRetain defined for this security\n profile. If any additionalMetricsToRetain are defined in the current invocation,\n an exception occurs.

" } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { - "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

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

The expected version of the security profile. A new version is generated whenever the\n security profile is updated. If you specify a value that is different from the actual version,\n a VersionConflictException is thrown.

", "smithy.api#httpQuery": "expectedVersion" } + }, + "metricsExportConfig": { + "target": "com.amazonaws.iot#MetricsExportConfig", + "traits": { + "smithy.api#documentation": "

Specifies the MQTT topic and role ARN required for metric export.

" + } + }, + "deleteMetricsExportConfig": { + "target": "com.amazonaws.iot#DeleteMetricsExportConfig", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Set the value as true to delete metrics export related configurations.

" + } } }, "traits": { @@ -34532,7 +34609,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

" } }, "alertTargets": { @@ -34547,13 +34624,13 @@ "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, - "smithy.api#documentation": "

\n Please use\n UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the security profile's behaviors, but\n it is\n also retained for any metric specified here.

" + "smithy.api#documentation": "

\n Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the security profile's behaviors, but it is also retained for any\n metric specified here.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { - "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" + "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but it is also retained for any metric specified here.\n Can be used with custom metrics; cannot be used with dimensions.

" } }, "version": { @@ -34574,6 +34651,12 @@ "traits": { "smithy.api#documentation": "

The time the security profile was last modified.

" } + }, + "metricsExportConfig": { + "target": "com.amazonaws.iot#MetricsExportConfig", + "traits": { + "smithy.api#documentation": "

Specifies the MQTT topic and role ARN required for metric export.

" + } } }, "traits": { @@ -35089,7 +35172,7 @@ "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { - "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

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

Specifies the behaviors that, when violated by a device (thing), cause an\n alert.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index 15404d24a81..2617244e400 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.json @@ -9964,6 +9964,12 @@ "traits": { "smithy.api#enumValue": "provided.al2023" } + }, + "python312": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "python3.12" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/mediatailor.json b/codegen/sdk-codegen/aws-models/mediatailor.json index b916048d1fe..d899e1bc50e 100644 --- a/codegen/sdk-codegen/aws-models/mediatailor.json +++ b/codegen/sdk-codegen/aws-models/mediatailor.json @@ -519,7 +519,6 @@ "EndOffsetMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.

", "smithy.api#required": {} } @@ -1152,7 +1151,6 @@ "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The duration of the live program in milliseconds.

" } } @@ -1434,28 +1432,24 @@ "ManifestWindowSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

" } }, "MinBufferTimeSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

" } }, "MinUpdatePeriodSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

" } }, "SuggestedPresentationDelaySeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

" } } @@ -2385,7 +2379,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } @@ -2519,7 +2512,6 @@ "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

" } }, @@ -2668,7 +2660,6 @@ "ManifestWindowSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

" } }, @@ -2788,7 +2779,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } @@ -2857,7 +2847,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } @@ -2918,7 +2907,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } @@ -2987,7 +2975,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "MaxResults" } @@ -3051,7 +3038,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#__integerMin1Max100", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

" } }, @@ -3124,7 +3110,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } @@ -3233,7 +3218,6 @@ "MaxResults": { "target": "com.amazonaws.mediatailor#MaxResults", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.

", "smithy.api#httpQuery": "maxResults" } @@ -3284,7 +3268,6 @@ "MaxDurationSeconds": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.

" } } @@ -3452,7 +3435,6 @@ "com.amazonaws.mediatailor#MaxResults": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -3579,7 +3561,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3622,7 +3603,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3635,7 +3617,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3649,7 +3630,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3672,7 +3652,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3707,7 +3686,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3718,14 +3696,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3739,14 +3719,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -3755,11 +3733,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3770,14 +3748,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3791,7 +3771,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3811,7 +3790,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3822,14 +3800,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3840,9 +3820,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -4385,7 +4367,6 @@ "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

" } }, @@ -4771,7 +4752,6 @@ "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

" } }, @@ -4874,7 +4854,6 @@ "PersonalizationThresholdSeconds": { "target": "com.amazonaws.mediatailor#__integerMin1", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

" } }, @@ -5036,7 +5015,6 @@ "ApproximateDurationSeconds": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The approximate duration of the ad break, in seconds.

" } }, @@ -5090,7 +5068,6 @@ "ApproximateDurationSeconds": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The approximate duration of this program, in seconds.

" } }, @@ -5412,28 +5389,24 @@ "AvailNum": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

" } }, "AvailsExpected": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

" } }, "SpliceEventId": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

" } }, "UniqueProgramId": { "target": "com.amazonaws.mediatailor#__integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

" } } @@ -5592,7 +5565,6 @@ "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The duration of the live program in seconds.

" } }, @@ -5612,7 +5584,6 @@ "ScheduledStartTimeMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The date and time that the program is scheduled to start, in epoch milliseconds.

" } }, @@ -6011,7 +5982,6 @@ "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The duration of the live program in milliseconds.

" } }, @@ -6049,14 +6019,12 @@ "ScheduledStartTimeMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The date and time that the program is scheduled to start, in epoch milliseconds.

" } }, "DurationMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The duration of the live program in seconds.

" } } @@ -6372,21 +6340,14 @@ } }, "com.amazonaws.mediatailor#__boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } + "type": "boolean" }, "com.amazonaws.mediatailor#__integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } + "type": "integer" }, "com.amazonaws.mediatailor#__integerMin1": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1 } @@ -6395,7 +6356,6 @@ "com.amazonaws.mediatailor#__integerMin1Max100": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 100 @@ -6481,10 +6441,7 @@ } }, "com.amazonaws.mediatailor#__long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } + "type": "long" }, "com.amazonaws.mediatailor#__mapOf__string": { "type": "map", diff --git a/codegen/sdk-codegen/aws-models/pipes.json b/codegen/sdk-codegen/aws-models/pipes.json index 88960b59138..3e2e217c4ca 100644 --- a/codegen/sdk-codegen/aws-models/pipes.json +++ b/codegen/sdk-codegen/aws-models/pipes.json @@ -361,6 +361,45 @@ } } }, + "com.amazonaws.pipes#CloudwatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:.+)$" + } + }, + "com.amazonaws.pipes#CloudwatchLogsLogDestination": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.pipes#CloudwatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

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

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#CloudwatchLogsLogDestinationParameters": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.pipes#CloudwatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

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

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, "com.amazonaws.pipes#ConflictException": { "type": "structure", "members": { @@ -494,7 +533,7 @@ "TargetParameters": { "target": "com.amazonaws.pipes#PipeTargetParameters", "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "RoleArn": { @@ -509,6 +548,13 @@ "traits": { "smithy.api#documentation": "

The list of key-value pairs to associate with the pipe.

" } + }, + "LogConfiguration": { + "target": "com.amazonaws.pipes#PipeLogConfigurationParameters", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } } }, "traits": { @@ -587,7 +633,7 @@ "Arn": { "target": "com.amazonaws.pipes#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.

" + "smithy.api#documentation": "

The ARN of the specified target for the dead-letter queue.

\n

For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify\n either an Amazon SNS topic or Amazon SQS queue ARN.

" } } }, @@ -824,7 +870,7 @@ "TargetParameters": { "target": "com.amazonaws.pipes#PipeTargetParameters", "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "RoleArn": { @@ -850,6 +896,13 @@ "traits": { "smithy.api#documentation": "

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" } + }, + "LogConfiguration": { + "target": "com.amazonaws.pipes#PipeLogConfiguration", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } } }, "traits": { @@ -1236,7 +1289,7 @@ } }, "traits": { - "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The collection of event patterns used to filter events.

\n

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

\n

For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#FilterList": { @@ -1251,6 +1304,45 @@ } } }, + "com.amazonaws.pipes#FirehoseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/.+)$" + } + }, + "com.amazonaws.pipes#FirehoseLogDestination": { + "type": "structure", + "members": { + "DeliveryStreamArn": { + "target": "com.amazonaws.pipes#FirehoseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

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

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#FirehoseLogDestinationParameters": { + "type": "structure", + "members": { + "DeliveryStreamArn": { + "target": "com.amazonaws.pipes#FirehoseArn", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

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

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, "com.amazonaws.pipes#HeaderKey": { "type": "string", "traits": { @@ -1281,6 +1373,26 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.pipes#IncludeExecutionData": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#IncludeExecutionDataOption" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.pipes#IncludeExecutionDataOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, "com.amazonaws.pipes#InputTemplate": { "type": "string", "traits": { @@ -1609,6 +1721,29 @@ } } }, + "com.amazonaws.pipes#LogLevel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "INFO", + "name": "INFO" + }, + { + "value": "TRACE", + "name": "TRACE" + } + ] + } + }, "com.amazonaws.pipes#LogStreamName": { "type": "string", "traits": { @@ -1794,12 +1929,6 @@ "type": "list", "member": { "target": "com.amazonaws.pipes#PathParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } } }, "com.amazonaws.pipes#Pipe": { @@ -1924,7 +2053,7 @@ "InputTemplate": { "target": "com.amazonaws.pipes#InputTemplate", "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

\n

To remove an input template, specify an empty string.

" } }, "HttpParameters": { @@ -1944,6 +2073,83 @@ "target": "com.amazonaws.pipes#Pipe" } }, + "com.amazonaws.pipes#PipeLogConfiguration": { + "type": "structure", + "members": { + "S3LogDestination": { + "target": "com.amazonaws.pipes#S3LogDestination", + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "FirehoseLogDestination": { + "target": "com.amazonaws.pipes#FirehoseLogDestination", + "traits": { + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, + "CloudwatchLogsLogDestination": { + "target": "com.amazonaws.pipes#CloudwatchLogsLogDestination", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, + "Level": { + "target": "com.amazonaws.pipes#LogLevel", + "traits": { + "smithy.api#documentation": "

The level of logging detail to include. This applies to all log destinations for the pipe.

" + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.pipes#IncludeExecutionData", + "traits": { + "smithy.api#documentation": "

Whether the execution data (specifically, the payload, awsRequest, and awsResponse fields) is included in the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

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

The logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#PipeLogConfigurationParameters": { + "type": "structure", + "members": { + "S3LogDestination": { + "target": "com.amazonaws.pipes#S3LogDestinationParameters", + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "FirehoseLogDestination": { + "target": "com.amazonaws.pipes#FirehoseLogDestinationParameters", + "traits": { + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, + "CloudwatchLogsLogDestination": { + "target": "com.amazonaws.pipes#CloudwatchLogsLogDestinationParameters", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, + "Level": { + "target": "com.amazonaws.pipes#LogLevel", + "traits": { + "smithy.api#documentation": "

The level of logging detail to include. This applies to all log destinations for the pipe.

\n

For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

", + "smithy.api#required": {} + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.pipes#IncludeExecutionData", + "traits": { + "smithy.api#documentation": "

Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

\n

The default is OFF.

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

Specifies the logging configuration settings for the pipe.

\n

When you call UpdatePipe, EventBridge updates the fields in the\n PipeLogConfigurationParameters object atomically as one and overrides\n existing values. This is by design. If you don't specify an optional field in any of the\n Amazon Web Services service parameters objects\n (CloudwatchLogsLogDestinationParameters,\n FirehoseLogDestinationParameters, or\n S3LogDestinationParameters), EventBridge sets that field to its\n system-default value during the update.

\n

For example, suppose when you created the pipe you\n specified a Kinesis Data Firehose stream log destination. You then update the pipe to add an\n Amazon S3 log destination. In addition to specifying the\n S3LogDestinationParameters for the new log destination, you must also\n specify the fields in the FirehoseLogDestinationParameters object in order to\n retain the Kinesis Data Firehose stream log destination.

\n

For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

" + } + }, "com.amazonaws.pipes#PipeName": { "type": "string", "traits": { @@ -2206,7 +2412,7 @@ "FilterCriteria": { "target": "com.amazonaws.pipes#FilterCriteria", "traits": { - "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The collection of event patterns used to filter events.

\n

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

\n

For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "KinesisStreamParameters": { @@ -2426,6 +2632,22 @@ { "value": "STOP_FAILED", "name": "STOP_FAILED" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "CREATE_ROLLBACK_FAILED", + "name": "CREATE_ROLLBACK_FAILED" + }, + { + "value": "DELETE_ROLLBACK_FAILED", + "name": "DELETE_ROLLBACK_FAILED" + }, + { + "value": "UPDATE_ROLLBACK_FAILED", + "name": "UPDATE_ROLLBACK_FAILED" } ] } @@ -2619,7 +2841,7 @@ "EndpointId": { "target": "com.amazonaws.pipes#EventBridgeEndpointId", "traits": { - "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

\n \n

When using Java, you must include auth-crt on the class path.

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

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

" } }, "DetailType": { @@ -2704,7 +2926,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a target.

" } }, "com.amazonaws.pipes#PipeTargetLambdaFunctionParameters": { @@ -2713,7 +2935,7 @@ "InvocationType": { "target": "com.amazonaws.pipes#PipeTargetInvocationType", "traits": { - "smithy.api#documentation": "

Choose from the following options.

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

Specify whether to invoke the function synchronously or asynchronously.

\n \n

For more information, see Invocation types in the Amazon EventBridge User Guide.

" } } }, @@ -2727,7 +2949,7 @@ "InputTemplate": { "target": "com.amazonaws.pipes#InputTemplate", "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

\n

To remove an input template, specify an empty string.

" } }, "LambdaFunctionParameters": { @@ -2745,7 +2967,7 @@ "KinesisStreamParameters": { "target": "com.amazonaws.pipes#PipeTargetKinesisStreamParameters", "traits": { - "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a target.

" } }, "EcsTaskParameters": { @@ -2763,7 +2985,7 @@ "SqsQueueParameters": { "target": "com.amazonaws.pipes#PipeTargetSqsQueueParameters", "traits": { - "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a target.

" } }, "HttpParameters": { @@ -2775,7 +2997,7 @@ "RedshiftDataParameters": { "target": "com.amazonaws.pipes#PipeTargetRedshiftDataParameters", "traits": { - "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API BatchExecuteStatement.

" } }, "SageMakerPipelineParameters": { @@ -2798,7 +3020,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#PipeTargetRedshiftDataParameters": { @@ -2807,7 +3029,7 @@ "SecretManagerArn": { "target": "com.amazonaws.pipes#SecretManagerArnOrJsonPath", "traits": { - "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using SageMaker.

" + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using Secrets Manager.

" } }, "Database": { @@ -2845,7 +3067,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API BatchExecuteStatement.

" } }, "com.amazonaws.pipes#PipeTargetSageMakerPipelineParameters": { @@ -2879,7 +3101,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a target.

" } }, "com.amazonaws.pipes#PipeTargetStateMachineParameters": { @@ -2888,7 +3110,7 @@ "InvocationType": { "target": "com.amazonaws.pipes#PipeTargetInvocationType", "traits": { - "smithy.api#documentation": "

Specify whether to wait for the state machine to finish or not.

" + "smithy.api#documentation": "

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

\n \n

For more information, see Invocation types in the Amazon EventBridge User Guide.

" } } }, @@ -3022,7 +3244,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3041,7 +3262,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -3069,13 +3289,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -3088,7 +3309,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3102,7 +3322,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3125,7 +3344,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3160,11 +3378,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -3175,16 +3391,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3198,14 +3417,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -3214,15 +3431,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -3233,16 +3449,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3256,7 +3475,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3276,11 +3494,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -3291,20 +3507,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -3315,18 +3533,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] }, @@ -3868,6 +4090,99 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$" } }, + "com.amazonaws.pipes#S3LogDestination": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

" + } + }, + "Prefix": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The prefix text with which to begin Amazon S3 log object names.

\n

For more information, see Organizing objects using prefixes\n in the Amazon Simple Storage Service User Guide.

" + } + }, + "BucketOwner": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

" + } + }, + "OutputFormat": { + "target": "com.amazonaws.pipes#S3OutputFormat", + "traits": { + "smithy.api#documentation": "

The format EventBridge uses for the log records.

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

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#S3LogDestinationParameters": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

", + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#required": {} + } + }, + "BucketOwner": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

", + "smithy.api#pattern": "^\\d{12}$", + "smithy.api#required": {} + } + }, + "OutputFormat": { + "target": "com.amazonaws.pipes#S3OutputFormat", + "traits": { + "smithy.api#documentation": "

How EventBridge should format the log records.

\n " + } + }, + "Prefix": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

Specifies any prefix text with which to begin Amazon S3 log object names.

\n

You can use prefixes to organize the data that you store in Amazon S3 buckets. \n A prefix is a string of characters at the beginning of the object key name. \n A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). \n For more information, see Organizing objects using prefixes\n in the Amazon Simple Storage Service User Guide.

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

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#S3OutputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "json", + "name": "JSON" + }, + { + "value": "plain", + "name": "PLAIN" + }, + { + "value": "w3c", + "name": "W3C" + } + ] + } + }, "com.amazonaws.pipes#SageMakerPipelineParameter": { "type": "structure", "members": { @@ -4122,7 +4437,8 @@ "traits": { "smithy.api#documentation": "// A list of SQLs.", "smithy.api#length": { - "min": 1 + "min": 1, + "max": 40 } } }, @@ -4685,7 +5001,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. \n The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or \n TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that \n if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

\n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

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

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged.\n The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or \n TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. \n EventBridge updates the fields in these objects atomically as one and overrides existing values. \n This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.

\n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/pipes/{Name}", @@ -4745,7 +5061,7 @@ "TargetParameters": { "target": "com.amazonaws.pipes#PipeTargetParameters", "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "RoleArn": { @@ -4754,6 +5070,13 @@ "smithy.api#documentation": "

The ARN of the role that allows the pipe to send data to the target.

", "smithy.api#required": {} } + }, + "LogConfiguration": { + "target": "com.amazonaws.pipes#PipeLogConfigurationParameters", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } } }, "traits": { @@ -4963,7 +5286,7 @@ "FilterCriteria": { "target": "com.amazonaws.pipes#FilterCriteria", "traits": { - "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The collection of event patterns used to filter events.

\n

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

\n

For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "KinesisStreamParameters": { diff --git a/codegen/sdk-codegen/aws-models/resource-explorer-2.json b/codegen/sdk-codegen/aws-models/resource-explorer-2.json index 15b7e34953b..9f7e808e127 100644 --- a/codegen/sdk-codegen/aws-models/resource-explorer-2.json +++ b/codegen/sdk-codegen/aws-models/resource-explorer-2.json @@ -1,6 +1,21 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.resourceexplorer2#AWSServiceAccessStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "ENABLED", + "value": "ENABLED" + }, + { + "name": "DISABLED", + "value": "DISABLED" + } + ] + } + }, "com.amazonaws.resourceexplorer2#AccessDeniedException": { "type": "structure", "members": { @@ -14,6 +29,21 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.resourceexplorer2#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.resourceexplorer2#AccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourceexplorer2#AccountId" + } + }, "com.amazonaws.resourceexplorer2#AssociateDefaultView": { "type": "operation", "input": { @@ -229,7 +259,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request failed because either you specified parameters that didn’t match the\n original request, or you attempted to create a view with a name that already exists in\n this Amazon Web Services Region.

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

If you attempted to create a view, then the request failed because either you specified parameters that didn’t match the\n original request, or you attempted to create a view with a name that already exists in\n this Amazon Web Services Region.

\n

If you attempted to create an index, then the request failed because either you specified parameters that didn't match\n the original request, or an index already exists in the current Amazon Web Services Region.

\n

If you attempted to update an index type to AGGREGATOR, then the request failed because you already\n have an AGGREGATOR index in a different Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -275,7 +305,7 @@ "target": "smithy.api#String", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

This value helps ensure idempotency. Resource Explorer uses this value to prevent the\n accidental creation of duplicate versions. We recommend that you generate a UUID-type\n value to ensure the uniqueness of your views.

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

This value helps ensure idempotency. Resource Explorer uses this value to prevent the\n accidental creation of duplicate versions. We recommend that you generate a UUID-type\n value to ensure the uniqueness of your index.

", "smithy.api#idempotencyToken": {} } }, @@ -379,6 +409,16 @@ "smithy.api#documentation": "

Specifies optional fields that you want included in search results from this\n view. It is a list of objects that each describe a field to include.

\n

The default is an empty list, with no optional fields included in the results.

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

The root ARN of the account, an organizational unit (OU), or an organization ARN. If\n left empty, the default is account.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "Filters": { "target": "com.amazonaws.resourceexplorer2#SearchFilter", "traits": { @@ -568,6 +608,9 @@ { "target": "com.amazonaws.resourceexplorer2#InternalServerException" }, + { + "target": "com.amazonaws.resourceexplorer2#ResourceNotFoundException" + }, { "target": "com.amazonaws.resourceexplorer2#ThrottlingException" }, @@ -584,6 +627,51 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.resourceexplorer2#GetAccountLevelServiceConfiguration": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.resourceexplorer2#GetAccountLevelServiceConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourceexplorer2#AccessDeniedException" + }, + { + "target": "com.amazonaws.resourceexplorer2#InternalServerException" + }, + { + "target": "com.amazonaws.resourceexplorer2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.resourceexplorer2#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the status of your account's Amazon Web Services service access, and validates the service\n linked role required to access the multi-account search feature. Only the management\n account or a delegated administrator with service access enabled can invoke this API\n call.

", + "smithy.api#http": { + "method": "POST", + "uri": "/GetAccountLevelServiceConfiguration" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resourceexplorer2#GetAccountLevelServiceConfigurationOutput": { + "type": "structure", + "members": { + "OrgConfiguration": { + "target": "com.amazonaws.resourceexplorer2#OrgConfiguration", + "traits": { + "smithy.api#documentation": "

Details about the organization, and whether configuration is ENABLED or\n DISABLED.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourceexplorer2#GetDefaultView": { "type": "operation", "input": { @@ -831,7 +919,7 @@ "Type": { "target": "com.amazonaws.resourceexplorer2#IndexType", "traits": { - "smithy.api#documentation": "

The type of index. It can be one of the following\n values:

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

The type of index. It can be one of the following values:

\n " } } }, @@ -944,6 +1032,102 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.resourceexplorer2#ListIndexesForMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourceexplorer2#ListIndexesForMembersInput" + }, + "output": { + "target": "com.amazonaws.resourceexplorer2#ListIndexesForMembersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourceexplorer2#AccessDeniedException" + }, + { + "target": "com.amazonaws.resourceexplorer2#InternalServerException" + }, + { + "target": "com.amazonaws.resourceexplorer2#ThrottlingException" + }, + { + "target": "com.amazonaws.resourceexplorer2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of a member's indexes in all Amazon Web Services Regions that are currently\n collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a\n delegated administrator with service access enabled can invoke this API call.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListIndexesForMembers" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "Indexes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.resourceexplorer2#ListIndexesForMembersInput": { + "type": "structure", + "members": { + "AccountIdList": { + "target": "com.amazonaws.resourceexplorer2#AccountIdList", + "traits": { + "smithy.api#documentation": "

The account IDs will limit the output to only indexes from these\n accounts.

", + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value appropriate to the \n operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.

\n \n

An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.

\n ", + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourceexplorer2#ListIndexesForMembersOutput": { + "type": "structure", + "members": { + "Indexes": { + "target": "com.amazonaws.resourceexplorer2#MemberIndexList", + "traits": { + "smithy.api#documentation": "

A structure that contains the details and status of each\n index.

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

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.\n The pagination tokens expire after 24 hours.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourceexplorer2#ListIndexesInput": { "type": "structure", "members": { @@ -976,7 +1160,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

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

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

", "smithy.api#length": { "min": 1, "max": 2048 @@ -997,7 +1181,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" + "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.\n The pagination tokens expire after 24 hours.

" } } } @@ -1045,7 +1229,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

" } }, "MaxResults": { @@ -1072,7 +1256,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" + "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.\n The pagination tokens expire after 24 hours.

" } } } @@ -1181,7 +1365,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

" } }, "MaxResults": { @@ -1190,7 +1374,7 @@ "smithy.api#documentation": "

The maximum number of results that you want included on each page of the \n response. If you do not include this parameter, it defaults to a value appropriate to the \n operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.

\n \n

An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.

\n ", "smithy.api#range": { "min": 1, - "max": 20 + "max": 50 } } } @@ -1208,9 +1392,68 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" + "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.\n The pagination tokens expire after 24 hours.

" + } + } + } + }, + "com.amazonaws.resourceexplorer2#MemberIndex": { + "type": "structure", + "members": { + "AccountId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The account ID for the index.

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

The Amazon Web Services Region in which the index\n exists.

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

The Amazon resource name (ARN) of the index.

" + } + }, + "Type": { + "target": "com.amazonaws.resourceexplorer2#IndexType", + "traits": { + "smithy.api#documentation": "

The type of index. It can be one of the following values:

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

An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services\n resources that the service discovers.

" + } + }, + "com.amazonaws.resourceexplorer2#MemberIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourceexplorer2#MemberIndex" + } + }, + "com.amazonaws.resourceexplorer2#OrgConfiguration": { + "type": "structure", + "members": { + "AWSServiceAccessStatus": { + "target": "com.amazonaws.resourceexplorer2#AWSServiceAccessStatus", + "traits": { + "smithy.api#documentation": "

This value displays whether your Amazon Web Services service access is ENABLED or DISABLED.

", + "smithy.api#required": {} + } + }, + "ServiceLinkedRole": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

This value shows whether or not you have a valid a service-linked role required to start the multi-account search feature.

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

This is a structure that contains the status of Amazon Web Services service access, and whether you have a valid service-linked role to enable \n multi-account search for your organization.

" } }, "com.amazonaws.resourceexplorer2#QueryString": { @@ -1310,12 +1553,18 @@ { "target": "com.amazonaws.resourceexplorer2#DisassociateDefaultView" }, + { + "target": "com.amazonaws.resourceexplorer2#GetAccountLevelServiceConfiguration" + }, { "target": "com.amazonaws.resourceexplorer2#GetDefaultView" }, { "target": "com.amazonaws.resourceexplorer2#GetIndex" }, + { + "target": "com.amazonaws.resourceexplorer2#ListIndexesForMembers" + }, { "target": "com.amazonaws.resourceexplorer2#ListSupportedResourceTypes" }, @@ -1401,7 +1650,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1429,7 +1677,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1442,7 +1691,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1456,7 +1704,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1476,7 +1723,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1490,14 +1736,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -1506,11 +1750,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1521,14 +1765,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1539,7 +1785,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1553,14 +1800,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -1569,11 +1814,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1584,14 +1829,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1602,9 +1849,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1888,7 +2137,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

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

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from. The pagination tokens expire after 24 hours.

", "smithy.api#length": { "min": 1, "max": 2048 @@ -1909,7 +2158,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

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

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.\n The pagination tokens expire after 24 hours.

", "smithy.api#length": { "min": 1, "max": 2048 @@ -1968,6 +2217,9 @@ "type": "list", "member": { "target": "smithy.api#String" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.resourceexplorer2#SupportedResourceType": { @@ -1997,6 +2249,9 @@ }, "value": { "target": "smithy.api#String" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.resourceexplorer2#TagResource": { @@ -2067,7 +2322,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request failed because you exceeded a rate limit for this operation. For more\n information, see Quotas\n for Resource Explorer.

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

The request failed because you exceeded a rate limit for this operation. For more\n information, see Quotas for\n Resource Explorer.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 12c31b9d70f..7e1a5236dcf 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -2790,7 +2790,7 @@ "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.

\n

The list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.

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

The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.

\n

The list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.

\n ", "smithy.api#required": {} } } @@ -7308,7 +7308,7 @@ "AutoMLJobObjective": { "target": "com.amazonaws.sagemaker#AutoMLJobObjective", "traits": { - "smithy.api#documentation": "

Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.

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

Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.

\n \n \n " } }, "ModelDeployConfig": { @@ -29497,17 +29497,13 @@ "SupportedContentTypes": { "target": "com.amazonaws.sagemaker#ContentTypes", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The supported MIME types for the input data.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The supported MIME types for the input data.

" } }, "SupportedResponseMIMETypes": { "target": "com.amazonaws.sagemaker#ResponseMIMETypes", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The supported MIME types for the output data.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The supported MIME types for the output data.

" } } }, @@ -55761,7 +55757,7 @@ "BaseModelName": { "target": "com.amazonaws.sagemaker#BaseModelName", "traits": { - "smithy.api#documentation": "

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon-7B-Instruct.\n

" + "smithy.api#documentation": "

The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large\n language models. For information on the list of supported models, see Text generation models supporting fine-tuning in Autopilot. If no\n BaseModelName is provided, the default model used is Falcon-7B-Instruct.\n

" } } }, diff --git a/codegen/sdk-codegen/aws-models/sfn.json b/codegen/sdk-codegen/aws-models/sfn.json index 24605d3c882..6afcef8f93e 100644 --- a/codegen/sdk-codegen/aws-models/sfn.json +++ b/codegen/sdk-codegen/aws-models/sfn.json @@ -102,6 +102,9 @@ { "target": "com.amazonaws.sfn#PublishStateMachineVersion" }, + { + "target": "com.amazonaws.sfn#RedriveExecution" + }, { "target": "com.amazonaws.sfn#SendTaskFailure" }, @@ -149,7 +152,7 @@ "name": "states" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Step Functions\n

Step Functions is a service that lets you coordinate the components of distributed applications\n and microservices using visual workflows.

\n

You can use Step Functions to build applications from individual components, each of which performs\n a discrete function, or task, allowing you to scale and change\n applications quickly. Step Functions provides a console that helps visualize the components of your\n application as a series of steps. Step Functions automatically triggers and tracks each step, and\n retries steps when there are errors, so your application executes predictably and in the right\n order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any\n issues.

\n

Step Functions manages operations and underlying infrastructure to ensure your application is\n available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has\n access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.\n For more information about Step Functions, see the \n Step Functions Developer Guide\n .

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

Step Functions is a service that lets you coordinate the components of distributed applications\n and microservices using visual workflows.

\n

You can use Step Functions to build applications from individual components, each of which performs\n a discrete function, or task, allowing you to scale and change\n applications quickly. Step Functions provides a console that helps visualize the components of your\n application as a series of steps. Step Functions automatically triggers and tracks each step, and\n retries steps when there are errors, so your application executes predictably and in the right\n order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any\n issues.

\n

Step Functions manages operations and underlying infrastructure to ensure your application is\n available at any scale. You can run tasks on Amazon Web Services, your own servers, or any system that has\n access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API.\n For more information about Step Functions, see the \n Step Functions Developer Guide\n .

\n \n

If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

\n ", "smithy.api#title": "AWS Step Functions", "smithy.api#xmlNamespace": { "uri": "http://swf.amazonaws.com/doc/2015-07-20/" @@ -196,7 +199,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -239,7 +241,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +255,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -266,7 +268,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -289,7 +290,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -324,7 +324,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -335,14 +334,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -356,14 +357,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -372,11 +371,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -406,14 +405,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -427,7 +428,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -447,7 +447,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -458,14 +457,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -476,9 +477,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1442,6 +1445,16 @@ "smithy.api#pattern": "^(?=.*[a-zA-Z_\\-\\.])[a-zA-Z0-9_\\-\\.]+$" } }, + "com.amazonaws.sfn#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[!-~]+$" + } + }, "com.amazonaws.sfn#CloudWatchEventsExecutionDataDetails": { "type": "structure", "members": { @@ -1857,7 +1870,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a state machine. This is an asynchronous operation: It sets the state machine's\n status to DELETING and begins the deletion process.

\n

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

\n

The following are some examples of qualified and unqualified state machine ARNs:

\n \n

This API action also deletes all versions and aliases associated with a state machine.

\n \n

For EXPRESS state machines, the deletion happens eventually (usually in\n less than a minute). Running executions may emit logs after DeleteStateMachine\n API is called.

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

Deletes a state machine. This is an asynchronous operation. It sets the state machine's\n status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.

\n

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

\n

The following are some examples of qualified and unqualified state machine ARNs:

\n \n

This API action also deletes all versions and aliases associated with a state machine.

\n \n

For EXPRESS state machines, the deletion happens eventually (usually in\n less than a minute). Running executions may emit logs after DeleteStateMachine\n API is called.

\n " } }, "com.amazonaws.sfn#DeleteStateMachineAlias": { @@ -2056,7 +2069,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about a state machine execution, such as the state machine\n associated with the execution, the execution input and output, and relevant execution\n metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was\n dispatched by a Map Run.

\n

If you specify a version or alias ARN when you call the StartExecution\n API action, DescribeExecution returns that ARN.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

Executions of an EXPRESS state machinearen't supported by DescribeExecution unless a Map Run dispatched them.

" + "smithy.api#documentation": "

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

\n

If you specify a version or alias ARN when you call the StartExecution\n API action, DescribeExecution returns that ARN.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

" } }, "com.amazonaws.sfn#DescribeExecutionInput": { @@ -2170,6 +2183,30 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

\n

If you start an execution from a StartExecution request with a\n state machine version ARN, this field will be null.

" } + }, + "redriveCount": { + "target": "com.amazonaws.sfn#RedriveCount", + "traits": { + "smithy.api#documentation": "

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.

" + } + }, + "redriveDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

\n

The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

" + } + }, + "redriveStatus": { + "target": "com.amazonaws.sfn#ExecutionRedriveStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether or not an execution can be redriven at a given point in time.

\n " + } + }, + "redriveStatusReason": { + "target": "com.amazonaws.sfn#SensitiveData", + "traits": { + "smithy.api#documentation": "

When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

\n " + } } }, "traits": { @@ -2193,7 +2230,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about a Map Run's configuration, progress, and results. For more information, see Examining Map Run in the Step Functions Developer Guide.

" + "smithy.api#documentation": "

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

" } }, "com.amazonaws.sfn#DescribeMapRunInput": { @@ -2285,6 +2322,18 @@ "smithy.api#documentation": "

A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.

", "smithy.api#required": {} } + }, + "redriveCount": { + "target": "com.amazonaws.sfn#RedriveCount", + "traits": { + "smithy.api#documentation": "

The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.

" + } + }, + "redriveDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.

" + } } }, "traits": { @@ -2761,12 +2810,90 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

\n

If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

" } + }, + "redriveCount": { + "target": "com.amazonaws.sfn#RedriveCount", + "traits": { + "smithy.api#documentation": "

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.

" + } + }, + "redriveDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the execution was last redriven.

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

Contains details about an execution.

" } }, + "com.amazonaws.sfn#ExecutionNotRedrivable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sfn#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sfn#ExecutionRedriveFilter": { + "type": "enum", + "members": { + "REDRIVEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDRIVEN" + } + }, + "NOT_REDRIVEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_REDRIVEN" + } + } + } + }, + "com.amazonaws.sfn#ExecutionRedriveStatus": { + "type": "enum", + "members": { + "REDRIVABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDRIVABLE" + } + }, + "NOT_REDRIVABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_REDRIVABLE" + } + }, + "REDRIVABLE_BY_MAP_RUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDRIVABLE_BY_MAP_RUN" + } + } + } + }, + "com.amazonaws.sfn#ExecutionRedrivenEventDetails": { + "type": "structure", + "members": { + "redriveCount": { + "target": "com.amazonaws.sfn#RedriveCount", + "traits": { + "smithy.api#documentation": "

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.

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

Contains details about a redriven execution.

" + } + }, "com.amazonaws.sfn#ExecutionStartedEventDetails": { "type": "structure", "members": { @@ -2837,6 +2964,12 @@ "traits": { "smithy.api#enumValue": "ABORTED" } + }, + "PENDING_REDRIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_REDRIVE" + } } } }, @@ -3151,6 +3284,12 @@ "executionTimedOutEventDetails": { "target": "com.amazonaws.sfn#ExecutionTimedOutEventDetails" }, + "executionRedrivenEventDetails": { + "target": "com.amazonaws.sfn#ExecutionRedrivenEventDetails", + "traits": { + "smithy.api#documentation": "

Contains details about the redrive attempt of an execution.

" + } + }, "mapStateStartedEventDetails": { "target": "com.amazonaws.sfn#MapStateStartedEventDetails", "traits": { @@ -3222,6 +3361,12 @@ "traits": { "smithy.api#documentation": "

Contains error and cause details about a Map Run that failed.

" } + }, + "mapRunRedrivenEventDetails": { + "target": "com.amazonaws.sfn#MapRunRedrivenEventDetails", + "traits": { + "smithy.api#documentation": "

Contains details about the redrive attempt of a Map Run.

" + } } }, "traits": { @@ -3608,6 +3753,18 @@ "traits": { "smithy.api#enumValue": "MapRunSucceeded" } + }, + "ExecutionRedriven": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExecutionRedriven" + } + }, + "MapRunRedriven": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MapRunRedriven" + } } } }, @@ -3959,7 +4116,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.

\n

You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

\n

Results are\n sorted by time, with the most recent execution first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

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

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions.

\n

You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version.

\n

Results are\n sorted by time, with the most recent execution first.

\n

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page.\n Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n \n

This API action is not supported by EXPRESS state machines.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4001,6 +4158,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

\n

You can specify either a mapRunArn or a stateMachineArn, but not both.

" } + }, + "redriveFilter": { + "target": "com.amazonaws.sfn#ExecutionRedriveFilter", + "traits": { + "smithy.api#documentation": "

Sets a filter to list executions based on whether or not they have been redriven.

\n

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

\n

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

\n

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

" + } } }, "traits": { @@ -4463,6 +4626,9 @@ } } }, + "com.amazonaws.sfn#LongObject": { + "type": "long" + }, "com.amazonaws.sfn#MapIterationEventDetails": { "type": "structure", "members": { @@ -4550,6 +4716,18 @@ "smithy.api#documentation": "

Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

", "smithy.api#required": {} } + }, + "failuresNotRedrivable": { + "target": "com.amazonaws.sfn#LongObject", + "traits": { + "smithy.api#documentation": "

The number of FAILED, ABORTED, or TIMED_OUT child workflow executions that cannot be redriven because their execution status is terminal. For example, if your execution event history contains 25,000 entries, or the toleratedFailureCount or toleratedFailurePercentage for the Distributed Map has exceeded.

" + } + }, + "pendingRedrive": { + "target": "com.amazonaws.sfn#LongObject", + "traits": { + "smithy.api#documentation": "

The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be FAILED, ABORTED, or TIMED_OUT in the original execution attempt or a previous redrive attempt.

" + } } }, "traits": { @@ -4642,6 +4820,18 @@ "smithy.api#documentation": "

Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.

", "smithy.api#required": {} } + }, + "failuresNotRedrivable": { + "target": "com.amazonaws.sfn#LongObject", + "traits": { + "smithy.api#documentation": "

The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, if your execution event history contains 25,000 entries, or the toleratedFailureCount or toleratedFailurePercentage for the Distributed Map has exceeded.

" + } + }, + "pendingRedrive": { + "target": "com.amazonaws.sfn#LongObject", + "traits": { + "smithy.api#documentation": "

The number of unsuccessful items in child workflow executions currently waiting to be redriven.

" + } } }, "traits": { @@ -4699,6 +4889,26 @@ "smithy.api#documentation": "

Contains details about a specific Map Run.

" } }, + "com.amazonaws.sfn#MapRunRedrivenEventDetails": { + "type": "structure", + "members": { + "mapRunArn": { + "target": "com.amazonaws.sfn#LongArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Map Run that was redriven.

" + } + }, + "redriveCount": { + "target": "com.amazonaws.sfn#RedriveCount", + "traits": { + "smithy.api#documentation": "

The number of times the Map Run has been redriven at this point in the execution's history including this event. The redrive count for a redriven Map Run is always greater than 0.

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

Contains details about a Map Run that was redriven.

" + } + }, "com.amazonaws.sfn#MapRunStartedEventDetails": { "type": "structure", "members": { @@ -4894,6 +5104,73 @@ "smithy.api#output": {} } }, + "com.amazonaws.sfn#RedriveCount": { + "type": "integer" + }, + "com.amazonaws.sfn#RedriveExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.sfn#RedriveExecutionInput" + }, + "output": { + "target": "com.amazonaws.sfn#RedriveExecutionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.sfn#ExecutionDoesNotExist" + }, + { + "target": "com.amazonaws.sfn#ExecutionLimitExceeded" + }, + { + "target": "com.amazonaws.sfn#ExecutionNotRedrivable" + }, + { + "target": "com.amazonaws.sfn#InvalidArn" + } + ], + "traits": { + "smithy.api#documentation": "

Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

\n

For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted.

\n

To redrive a workflow that includes a Distributed Map state with failed child workflow executions, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including Distributed Map.

\n \n

This API action is not supported by EXPRESS state machines.

\n

However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs.

\n \n

You can redrive executions if your original execution meets the following conditions:

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.sfn#RedriveExecutionInput": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.sfn#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution to be redriven.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.sfn#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API uses one of the last 10 client tokens provided.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sfn#RedriveExecutionOutput": { + "type": "structure", + "members": { + "redriveDate": { + "target": "com.amazonaws.sfn#Timestamp", + "traits": { + "smithy.api#documentation": "

The date the execution was last redriven.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sfn#ResourceNotFound": { "type": "structure", "members": { @@ -4945,7 +5222,7 @@ "target": "com.amazonaws.sfn#VersionWeight", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The percentage of traffic you want to route to the second state machine\n version. The sum of the weights in the routing\n configuration must be equal to 100.

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

The percentage of traffic you want to route to a state machine\n version. The sum of the weights in the routing\n configuration must be equal to 100.

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

Used by activity workers and task states using the callback\n pattern to report that the task identified by the taskToken failed.

" + "smithy.api#documentation": "

Used by activity workers, Task states using the callback\n pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

" } }, "com.amazonaws.sfn#SendTaskFailureInput": { @@ -5031,7 +5308,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used by activity workers and task states using the callback\n pattern to report to Step Functions that the task represented by the specified\n taskToken is still making progress. This action resets the\n Heartbeat clock. The Heartbeat threshold is specified in the state\n machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself\n create an event in the execution history. However, if the task times out, the execution\n history contains an ActivityTimedOut entry for activities, or a\n TaskTimedOut entry for for tasks using the job run or\n callback\n pattern.

\n \n

The Timeout of a task, defined in the state machine's Amazon States Language definition, is\n its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval\n for heartbeats.

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

Used by activity workers and Task states using the callback\n pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified\n taskToken is still making progress. This action resets the\n Heartbeat clock. The Heartbeat threshold is specified in the state\n machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself\n create an event in the execution history. However, if the task times out, the execution\n history contains an ActivityTimedOut entry for activities, or a\n TaskTimedOut entry for tasks using the job run or\n callback\n pattern.

\n \n

The Timeout of a task, defined in the state machine's Amazon States Language definition, is\n its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval\n for heartbeats.

\n " } }, "com.amazonaws.sfn#SendTaskHeartbeatInput": { @@ -5079,7 +5356,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used by activity workers and task states using the callback\n pattern to report that the task identified by the taskToken completed\n successfully.

" + "smithy.api#documentation": "

Used by activity workers, Task states using the callback\n pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed\n successfully.

" } }, "com.amazonaws.sfn#SendTaskSuccessInput": { @@ -5216,7 +5493,7 @@ "name": { "target": "com.amazonaws.sfn#Name", "traits": { - "smithy.api#documentation": "

Optional name of the execution.\n This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the Step Functions Developer Guide.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" + "smithy.api#documentation": "

Optional name of the execution.\n This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,\n see \n Limits Related to State Machine Executions in the Step Functions Developer Guide.

\n

If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

\n

A name must not contain:

\n \n

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

" } }, "input": { @@ -5874,6 +6151,7 @@ } }, "traits": { + "smithy.api#documentation": "

The activity does not exist.

", "smithy.api#error": "client" } }, @@ -6133,6 +6411,7 @@ } }, "traits": { + "smithy.api#documentation": "

The task token has either expired or the task associated with the token has already been closed.

", "smithy.api#error": "client" } }, diff --git a/codegen/sdk-codegen/aws-models/signer.json b/codegen/sdk-codegen/aws-models/signer.json index 6bc64142ba4..e8130694a01 100644 --- a/codegen/sdk-codegen/aws-models/signer.json +++ b/codegen/sdk-codegen/aws-models/signer.json @@ -122,7 +122,7 @@ "principal": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

The AWS principal receiving cross-account permissions. This may be an IAM role or\n\t\t\tanother AWS account ID.

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

The AWS principal receiving cross-account permissions. This may be an IAM role or another\n\t\t\tAWS account ID.

", "smithy.api#required": {} } }, @@ -457,7 +457,7 @@ "signedObject": { "target": "com.amazonaws.signer#SignedObject", "traits": { - "smithy.api#documentation": "

Name of the S3 bucket where the signed code image is saved by code signing.

" + "smithy.api#documentation": "

Name of the S3 bucket where the signed code image is saved by AWS Signer.

" } }, "jobOwner": { @@ -517,20 +517,20 @@ "allowedValues": { "target": "com.amazonaws.signer#EncryptionAlgorithms", "traits": { - "smithy.api#documentation": "

The set of accepted encryption algorithms that are allowed in a code signing job.

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

The set of accepted encryption algorithms that are allowed in a code-signing job.

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.signer#EncryptionAlgorithm", "traits": { - "smithy.api#documentation": "

The default encryption algorithm that is used by a code signing job.

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

The default encryption algorithm that is used by a code-signing job.

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

The encryption algorithm options that are available to a code signing job.

" + "smithy.api#documentation": "

The encryption algorithm options that are available to a code-signing job.

" } }, "com.amazonaws.signer#EncryptionAlgorithms": { @@ -568,7 +568,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the\n\t\t\trevocation status of one or more of the signing profile, signing job, and signing\n\t\t\tcertificate.

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

Retrieves the revocation status of one or more of the signing profile, signing job,\n\t\t\tand signing certificate.

", "smithy.api#endpoint": { "hostPrefix": "verification." }, @@ -617,7 +617,7 @@ "certificateHashes": { "target": "com.amazonaws.signer#CertificateHashes", "traits": { - "smithy.api#documentation": "

A list of composite signed hashes that identify certificates.

\n\t\t

A certificate identifier consists of a subject certificate TBS hash (signed by the\n\t\t\tparent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root\n\t\t\tcertificates are defined as their own CA.

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

A list of composite signed hashes that identify certificates.

\n\t\t

A certificate identifier consists of a subject certificate TBS hash (signed by the\n\t\t\tparent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root\n\t\t\tcertificates are defined as their own CA.

\n\t\t

The following example shows how to calculate a hash for this parameter using OpenSSL\n\t\t\tcommands:

\n\t\t\n\t\t\t

\n openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs \n

\n\t\t\t

\n openssl sha384 < childCert.tbs -binary > childCertTbsHash \n

\n\t\t\t

\n openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs \n

\n\t\t\t

\n openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p\n\t\t\t\tchildCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >>\n\t\t\t\tcertificateHash.hex\n

\n\t\t\t

\n cat certificateHash.hex | tr -d '\\n'\n

", "smithy.api#httpQuery": "certificateHashes", "smithy.api#required": {} } @@ -633,7 +633,7 @@ "revokedEntities": { "target": "com.amazonaws.signer#RevokedEntities", "traits": { - "smithy.api#documentation": "

A list of revoked entities (including one or more of the signing profile ARN, signing\n\t\t\tjob ID, and certificate hash) supplied as input to the API.

" + "smithy.api#documentation": "

A list of revoked entities (including zero or more of the signing profile ARN, signing job\n\t\t\tARN, and certificate hashes) supplied as input to the API.

" } } }, @@ -915,20 +915,20 @@ "allowedValues": { "target": "com.amazonaws.signer#HashAlgorithms", "traits": { - "smithy.api#documentation": "

The set of accepted hash algorithms allowed in a code signing job.

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

The set of accepted hash algorithms allowed in a code-signing job.

", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.signer#HashAlgorithm", "traits": { - "smithy.api#documentation": "

The default hash algorithm that is used in a code signing job.

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

The default hash algorithm that is used in a code-signing job.

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

The hash algorithms that are available to a code signing job.

" + "smithy.api#documentation": "

The hash algorithms that are available to a code-signing job.

" } }, "com.amazonaws.signer#HashAlgorithms": { @@ -1107,7 +1107,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all your signing jobs. You can use the maxResults parameter to\n\t\t\tlimit the number of signing jobs that are returned in the response. If additional jobs\n\t\t\tremain to be listed, code signing returns a nextToken value. Use this value in\n\t\t\tsubsequent calls to ListSigningJobs to fetch the remaining values. You can\n\t\t\tcontinue calling ListSigningJobs with your maxResults\n\t\t\tparameter and with new values that code signing returns in the nextToken\n\t\t\tparameter until all of your signing jobs have been returned.

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

Lists all your signing jobs. You can use the maxResults parameter to limit the\n\t\t\tnumber of signing jobs that are returned in the response. If additional jobs remain to\n\t\t\tbe listed, AWS Signer returns a nextToken value. Use this value in\n\t\t\tsubsequent calls to ListSigningJobs to fetch the remaining values. You can\n\t\t\tcontinue calling ListSigningJobs with your maxResults\n\t\t\tparameter and with new values that Signer returns in the nextToken\n\t\t\tparameter until all of your signing jobs have been returned.

", "smithy.api#http": { "method": "GET", "uri": "/signing-jobs", @@ -1235,7 +1235,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all signing platforms available in code signing that match the request parameters. If\n\t\t\tadditional jobs remain to be listed, code signing returns a nextToken value. Use\n\t\t\tthis value in subsequent calls to ListSigningJobs to fetch the remaining\n\t\t\tvalues. You can continue calling ListSigningJobs with your\n\t\t\t\tmaxResults parameter and with new values that code signing returns in the\n\t\t\t\tnextToken parameter until all of your signing jobs have been\n\t\t\treturned.

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

Lists all signing platforms available in AWS Signer that match the request parameters. If\n\t\t\tadditional jobs remain to be listed, Signer returns a nextToken value.\n\t\t\tUse this value in subsequent calls to ListSigningJobs to fetch the\n\t\t\tremaining values. You can continue calling ListSigningJobs with your\n\t\t\t\tmaxResults parameter and with new values that Signer returns in the\n\t\t\t\tnextToken parameter until all of your signing jobs have been\n\t\t\treturned.

", "smithy.api#http": { "method": "GET", "uri": "/signing-platforms", @@ -1331,7 +1331,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all available signing profiles in your AWS account. Returns only profiles with\n\t\t\tan ACTIVE status unless the includeCanceled request field is\n\t\t\tset to true. If additional jobs remain to be listed, code signing returns a\n\t\t\t\tnextToken value. Use this value in subsequent calls to\n\t\t\t\tListSigningJobs to fetch the remaining values. You can continue calling\n\t\t\t\tListSigningJobs with your maxResults parameter and with\n\t\t\tnew values that code signing returns in the nextToken parameter until all of your\n\t\t\tsigning jobs have been returned.

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

Lists all available signing profiles in your AWS account. Returns only profiles with an\n\t\t\t\tACTIVE status unless the includeCanceled request field is\n\t\t\tset to true. If additional jobs remain to be listed, AWS Signer returns a\n\t\t\t\tnextToken value. Use this value in subsequent calls to\n\t\t\t\tListSigningJobs to fetch the remaining values. You can continue calling\n\t\t\t\tListSigningJobs with your maxResults parameter and with\n\t\t\tnew values that Signer returns in the nextToken parameter until all of\n\t\t\tyour signing jobs have been returned.

", "smithy.api#http": { "method": "GET", "uri": "/signing-profiles", @@ -1617,7 +1617,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a signing profile. A signing profile is a code signing template that can be used to\n\t\t\tcarry out a pre-defined signing job.\n\t\t\t

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

Creates a signing profile. A signing profile is a code-signing template that can be used to\n\t\t\tcarry out a pre-defined signing job.\n\t\t\t

", "smithy.api#http": { "method": "PUT", "uri": "/signing-profiles/{profileName}", @@ -1967,12 +1967,12 @@ "prefix": { "target": "com.amazonaws.signer#Prefix", "traits": { - "smithy.api#documentation": "

An Amazon S3 prefix that you can use to limit responses to those that begin with the\n\t\t\tspecified prefix.

" + "smithy.api#documentation": "

An S3 prefix that you can use to limit responses to those that begin with the specified\n\t\t\tprefix.

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

The name and prefix of the S3 bucket where code signing saves your signed objects.

" + "smithy.api#documentation": "

The name and prefix of the Amazon S3 bucket where AWS Signer saves your signed objects.

" } }, "com.amazonaws.signer#S3SignedObject": { @@ -1992,7 +1992,7 @@ } }, "traits": { - "smithy.api#documentation": "

The S3 bucket name and key where code signing saved your signed code image.

" + "smithy.api#documentation": "

The Amazon S3 bucket name and key where Signer saved your signed code image.

" } }, "com.amazonaws.signer#S3Source": { @@ -2021,7 +2021,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the S3 bucket where you saved your unsigned code.

" + "smithy.api#documentation": "

Information about the Amazon S3 bucket where you saved your unsigned code.

" } }, "com.amazonaws.signer#ServiceLimitExceededException": { @@ -2066,7 +2066,7 @@ } ], "traits": { - "smithy.api#documentation": "

Signs a binary\n\t\t\tpayload and returns a signature envelope.

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

Signs a binary payload and returns a signature envelope.

", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs/with-payload", @@ -2100,7 +2100,7 @@ "payloadFormat": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

Payload content type

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

Payload content type. The single valid type is\n\t\t\t\tapplication/vnd.cncf.notary.payload.v1+json.

", "smithy.api#required": {} } } @@ -2127,7 +2127,7 @@ "metadata": { "target": "com.amazonaws.signer#Metadata", "traits": { - "smithy.api#documentation": "

Information including the signing profile ARN and the signing job ID. Clients use\n\t\t\tmetadata to signature records, for example, as annotations added to the signature\n\t\t\tmanifest inside an OCI registry.

" + "smithy.api#documentation": "

Information including the signing profile ARN and the signing job ID.

" } }, "signature": { @@ -2182,20 +2182,20 @@ "encryptionAlgorithmOptions": { "target": "com.amazonaws.signer#EncryptionAlgorithmOptions", "traits": { - "smithy.api#documentation": "

The encryption algorithm options that are available for a code signing job.

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

The encryption algorithm options that are available for a code-signing job.

", "smithy.api#required": {} } }, "hashAlgorithmOptions": { "target": "com.amazonaws.signer#HashAlgorithmOptions", "traits": { - "smithy.api#documentation": "

The hash algorithm options that are available for a code signing job.

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

The hash algorithm options that are available for a code-signing job.

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

The configuration of a code signing operation.

" + "smithy.api#documentation": "

The configuration of a signing operation.

" } }, "com.amazonaws.signer#SigningConfigurationOverrides": { @@ -2204,13 +2204,13 @@ "encryptionAlgorithm": { "target": "com.amazonaws.signer#EncryptionAlgorithm", "traits": { - "smithy.api#documentation": "

A specified override of the default encryption algorithm that is used in a code signing\n\t\t\tjob.

" + "smithy.api#documentation": "

A specified override of the default encryption algorithm that is used in a code-signing\n\t\t\tjob.

" } }, "hashAlgorithm": { "target": "com.amazonaws.signer#HashAlgorithm", "traits": { - "smithy.api#documentation": "

A specified override of the default hash algorithm that is used in a code signing\n\t\t\tjob.

" + "smithy.api#documentation": "

A specified override of the default hash algorithm that is used in a code-signing\n\t\t\tjob.

" } } }, @@ -2224,20 +2224,20 @@ "supportedFormats": { "target": "com.amazonaws.signer#ImageFormats", "traits": { - "smithy.api#documentation": "

The supported formats of a code signing image.

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

The supported formats of a signing image.

", "smithy.api#required": {} } }, "defaultFormat": { "target": "com.amazonaws.signer#ImageFormat", "traits": { - "smithy.api#documentation": "

The default format of a code signing image.

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

The default format of a signing image.

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

The image format of a code signing platform or profile.

" + "smithy.api#documentation": "

The image format of a AWS Signer platform or profile.

" } }, "com.amazonaws.signer#SigningJob": { @@ -2401,37 +2401,37 @@ "platformId": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

The ID of a code signing platform.

" + "smithy.api#documentation": "

The ID of a signing platform.

" } }, "displayName": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

The display name of a code signing platform.

" + "smithy.api#documentation": "

The display name of a signing platform.

" } }, "partner": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

Any partner entities linked to a code signing platform.

" + "smithy.api#documentation": "

Any partner entities linked to a signing platform.

" } }, "target": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "

The types of targets that can be signed by a code signing platform.

" + "smithy.api#documentation": "

The types of targets that can be signed by a signing platform.

" } }, "category": { "target": "com.amazonaws.signer#Category", "traits": { - "smithy.api#documentation": "

The category of a code signing platform.

" + "smithy.api#documentation": "

The category of a signing platform.

" } }, "signingConfiguration": { "target": "com.amazonaws.signer#SigningConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of a code signing platform. This includes the designated hash algorithm\n\t\t\tand encryption algorithm of a signing platform.

" + "smithy.api#documentation": "

The configuration of a signing platform. This includes the designated hash algorithm and\n\t\t\tencryption algorithm of a signing platform.

" } }, "signingImageFormat": { @@ -2441,7 +2441,7 @@ "target": "com.amazonaws.signer#MaxSizeInMB", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum size (in MB) of code that can be signed by a code signing platform.

" + "smithy.api#documentation": "

The maximum size (in MB) of code that can be signed by a signing platform.

" } }, "revocationSupported": { @@ -2453,7 +2453,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the signing configurations and parameters that are used to\n\t\t\tperform a code signing job.

" + "smithy.api#documentation": "

Contains information about the signing configurations and parameters that are used to\n\t\t\tperform a code-signing job.

" } }, "com.amazonaws.signer#SigningPlatformOverrides": { @@ -2473,7 +2473,7 @@ } }, "traits": { - "smithy.api#documentation": "

Any overrides that are applied to the signing configuration of a code signing\n\t\t\tplatform.

" + "smithy.api#documentation": "

Any overrides that are applied to the signing configuration of a signing platform.

" } }, "com.amazonaws.signer#SigningPlatforms": { @@ -2530,13 +2530,13 @@ "signingParameters": { "target": "com.amazonaws.signer#SigningParameters", "traits": { - "smithy.api#documentation": "

The parameters that are available for use by a code signing user.

" + "smithy.api#documentation": "

The parameters that are available for use by a Signer user.

" } }, "status": { "target": "com.amazonaws.signer#SigningProfileStatus", "traits": { - "smithy.api#documentation": "

The status of a code signing profile.

" + "smithy.api#documentation": "

The status of a signing profile.

" } }, "arn": { @@ -2553,7 +2553,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the ACM certificates and code signing configuration parameters\n\t\t\tthat can be used by a given code signing user.

" + "smithy.api#documentation": "

Contains information about the ACM certificates and signing configuration parameters that\n\t\t\tcan be used by a given code signing user.

" } }, "com.amazonaws.signer#SigningProfileRevocationRecord": { @@ -2677,7 +2677,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:

\n\t\t \n\t\t

You can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.

\n\t\t

For a Java example that shows how to use this action, see StartSigningJob.

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

Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:

\n\t\t \n\t\t

You can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.

\n\t\t

For a Java example that shows how to use this action, see StartSigningJob.

", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs", @@ -3083,7 +3083,7 @@ "name": "signer" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Signer is a fully managed code signing service to help you ensure the trust and\n\t\t\tintegrity of your code.

\n\t\t

AWS Signer supports the following applications:

\n\t\t

With code signing for AWS Lambda, you can sign AWS\n\t\t\t\tLambda deployment packages. Integrated support is provided for Amazon S3, Amazon\n\t\t\t\tCloudWatch, and AWS CloudTrail. In order\n\t\t\tto sign code, you create a signing profile and then use Signer to sign Lambda zip files\n\t\t\tin S3.

\n\t\t

With code signing for IoT, you can sign code for any IoT device that is supported by AWS.\n\t\t\tIoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code signing\n\t\t\tcertificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

\n\t\t

With code signing for\n\t\t\tcontainers …(TBD)

\n\t\t

For more information about AWS Signer, see the AWS Signer Developer\n\t\t\tGuide.

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

AWS Signer is a fully managed code-signing service to help you ensure the trust and\n\t\t\tintegrity of your code.

\n\t\t

Signer supports the following applications:

\n\t\t

With code signing for AWS Lambda, you can sign AWS\n\t\t\t\tLambda deployment packages. Integrated support is provided for Amazon S3, Amazon\n\t\t\t\tCloudWatch, and AWS CloudTrail. In order\n\t\t\tto sign code, you create a signing profile and then use Signer to sign Lambda zip\n\t\t\tfiles in S3.

\n\t\t

With code signing for IoT, you can sign code for any IoT device that is supported by AWS.\n\t\t\tIoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code-signing\n\t\t\tcertificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.

\n\t\t

With Signer and the Notation CLI from the Notary\u2028\n\t\t\t\tProject, you can sign container images stored in a container registry such\n\t\t\tas Amazon Elastic Container Registry (ECR). The signatures are stored in the registry\n\t\t\talongside the images, where they are available for verifying image authenticity and\n\t\t\tintegrity.

\n\t\t

For more information about Signer, see the AWS Signer Developer\n\t\t\tGuide.

", "smithy.api#title": "AWS Signer", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3127,7 +3127,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3170,7 +3169,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3183,7 +3183,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3197,7 +3196,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3220,7 +3218,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3255,7 +3252,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3266,14 +3262,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3287,14 +3285,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -3303,11 +3299,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3318,14 +3314,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -3339,7 +3337,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -3359,7 +3356,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -3370,14 +3366,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -3388,9 +3386,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [],