From 32b9f4de9b2af8bbcb30aa70b80770e70983661e Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Thu, 18 Jan 2024 19:06:11 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/b2bi.json | 13 +- .../sdk-codegen/aws-models/cloudtrail.json | 258 ++++++++- codegen/sdk-codegen/aws-models/connect.json | 14 +- codegen/sdk-codegen/aws-models/drs.json | 28 +- codegen/sdk-codegen/aws-models/firehose.json | 542 ++++++++++++++++++ .../sagemaker-featurestore-runtime.json | 4 +- 6 files changed, 815 insertions(+), 44 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/b2bi.json b/codegen/sdk-codegen/aws-models/b2bi.json index 50dc81eab92..3fc8f2b3190 100644 --- a/codegen/sdk-codegen/aws-models/b2bi.json +++ b/codegen/sdk-codegen/aws-models/b2bi.json @@ -3143,6 +3143,9 @@ "target": "com.amazonaws.b2bi#ListTagsForResourceResponse" }, "errors": [ + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, { "target": "com.amazonaws.b2bi#ResourceNotFoundException" }, @@ -3893,6 +3896,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, { "target": "com.amazonaws.b2bi#ResourceNotFoundException" }, @@ -4011,7 +4017,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 200000 + "max": 5000000 } } }, @@ -4085,7 +4091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Parses the input EDI (electronic data interchange) file.

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

Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.

", "smithy.api#examples": [ { "title": "Sample TestParsing call", @@ -4388,6 +4394,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, { "target": "com.amazonaws.b2bi#ResourceNotFoundException" }, diff --git a/codegen/sdk-codegen/aws-models/cloudtrail.json b/codegen/sdk-codegen/aws-models/cloudtrail.json index 92a3b9c32cd..b3f472e6ad8 100644 --- a/codegen/sdk-codegen/aws-models/cloudtrail.json +++ b/codegen/sdk-codegen/aws-models/cloudtrail.json @@ -266,7 +266,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.

\n

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.

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

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.

\n

For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.

\n ", "smithy.api#required": {} } }, @@ -747,6 +747,9 @@ { "target": "com.amazonaws.cloudtrail#ListImports" }, + { + "target": "com.amazonaws.cloudtrail#ListInsightsMetricData" + }, { "target": "com.amazonaws.cloudtrail#ListPublicKeys" }, @@ -2415,7 +2418,7 @@ "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs will be delivered. You must use a\n log group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

\n \n

Only the management account can configure a CloudWatch Logs log group for an organization trail.

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

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs will be delivered. You must use a\n log group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" } }, "CloudWatchLogsRoleArn": { @@ -2539,7 +2542,7 @@ "Type": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \n

The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector.

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

The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:

\n \n

Additional resource types are available through advanced\n event selectors. For more\n information about these additional resource types, see AdvancedFieldSelector.

" } }, "Values": { @@ -3169,7 +3172,7 @@ "Type": { "target": "com.amazonaws.cloudtrail#DestinationType", "traits": { - "smithy.api#documentation": "

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EventDataStore. For service-linked channels, \n the value is AWS_SERVICE.

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

The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, \n the value is AWS_SERVICE.

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

\n Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail \n removes the metadata associated with the federated event data store in the Glue Data Catalog and removes registration for\n the federation role ARN and event data store in Lake Formation. No CloudTrail Lake data is deleted \n when you disable federation.\n

" + "smithy.api#documentation": "

\n Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables \n the integration with Glue, Lake Formation, and Amazon Athena. \n After disabling Lake query federation, you can no longer query your event data in Amazon Athena.

\n

No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.

" } }, "com.amazonaws.cloudtrail#DisableFederationRequest": { @@ -3305,6 +3308,9 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudtrail#Double": { + "type": "double" + }, "com.amazonaws.cloudtrail#EnableFederation": { "type": "operation", "input": { @@ -3361,7 +3367,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue \n Data Catalog and run \n SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog \n lets the Athena query engine know how to find, read, and process the data that you want to query.

\n

When you enable Lake query federation, CloudTrail\n creates a federated database named aws:cloudtrail (if the database doesn't already exist) and a federated table in\n the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in\n Lake Formation, the service responsible for revoking or granting permissions\n to the federated resources in the Glue Data Catalog.\n

\n

For more information about Lake query federation, see Federate an event data store.

" + "smithy.api#documentation": "

\n Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue \n Data Catalog and run \n SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog \n lets the Athena query engine know how to find, read, and process the data that you want to query.

\n

When you enable Lake query federation, CloudTrail\n creates a managed database named aws:cloudtrail (if the database doesn't already exist) and a managed federated table in\n the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in\n Lake Formation, the service responsible for allowing fine-grained access control \n of the federated resources in the Glue Data Catalog.

\n

For more information about Lake query federation, see Federate an event data store.

" } }, "com.amazonaws.cloudtrail#EnableFederationRequest": { @@ -3412,6 +3418,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudtrail#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[\\w\\d\\s_.,\\-:\\[\\]]+$" + } + }, "com.amazonaws.cloudtrail#ErrorMessage": { "type": "string", "traits": { @@ -3804,6 +3820,16 @@ "target": "com.amazonaws.cloudtrail#EventDataStore" } }, + "com.amazonaws.cloudtrail#EventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, "com.amazonaws.cloudtrail#EventSelector": { "type": "structure", "members": { @@ -3842,6 +3868,16 @@ "target": "com.amazonaws.cloudtrail#EventSelector" } }, + "com.amazonaws.cloudtrail#EventSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9_-]+\\.amazonaws\\.com$" + } + }, "com.amazonaws.cloudtrail#EventsList": { "type": "list", "member": { @@ -5165,6 +5201,56 @@ } } }, + "com.amazonaws.cloudtrail#InsightsMetricDataType": { + "type": "enum", + "members": { + "FILL_WITH_ZEROS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FillWithZeros" + } + }, + "NON_ZERO_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NonZeroData" + } + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 21600 + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricPeriod": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 3600 + } + } + }, + "com.amazonaws.cloudtrail#InsightsMetricValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Double" + } + }, "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException": { "type": "structure", "members": { @@ -6174,6 +6260,156 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudtrail#ListInsightsMetricData": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListInsightsMetricDataRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListInsightsMetricDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, \n EventName, and InsightType parameters.

\n

If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter.

\n

The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive.

\n \n

Access to the ListInsightsMetricData API operation is linked to the cloudtrail:LookupEvents action. To use this operation, \n you must have permissions to perform the cloudtrail:LookupEvents action.

", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListInsightsMetricDataRequest": { + "type": "structure", + "members": { + "EventSource": { + "target": "com.amazonaws.cloudtrail#EventSource", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

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

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

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

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. \n The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. \n The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

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

Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

\n

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

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

Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

\n

The default is 90 days before the time of request.

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

Specifies, in UTC, the end time for time-series data. The value specified is exclusive; \n results include data points up to the specified time stamp.

\n

The default is the time of request.

" + } + }, + "Period": { + "target": "com.amazonaws.cloudtrail#InsightsMetricPeriod", + "traits": { + "smithy.api#documentation": "

Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. \n If you specify any other value, you will get an error. The default is 3600 seconds.

" + } + }, + "DataType": { + "target": "com.amazonaws.cloudtrail#InsightsMetricDataType", + "traits": { + "smithy.api#documentation": "

Type of datapoints to return. Valid values are NonZeroData and \n FillWithZeros. The default is NonZeroData.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#InsightsMetricMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of datapoints to return. Valid values are integers from 1 to 21600. \n The default value is 21600.

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

Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

\n

Add this parameter to the request to continue retrieving results starting from the last evaluated point.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudtrail#ListInsightsMetricDataResponse": { + "type": "structure", + "members": { + "EventSource": { + "target": "com.amazonaws.cloudtrail#EventSource", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

" + } + }, + "EventName": { + "target": "com.amazonaws.cloudtrail#EventName", + "traits": { + "smithy.api#documentation": "

The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

" + } + }, + "InsightType": { + "target": "com.amazonaws.cloudtrail#InsightType", + "traits": { + "smithy.api#documentation": "

The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. \n The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. \n The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.cloudtrail#ErrorCode", + "traits": { + "smithy.api#documentation": "

Only returned if InsightType parameter was set to ApiErrorRateInsight.

\n

If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

" + } + }, + "Timestamps": { + "target": "com.amazonaws.cloudtrail#Timestamps", + "traits": { + "smithy.api#documentation": "

List of timestamps at intervals corresponding to the specified time period.

" + } + }, + "Values": { + "target": "com.amazonaws.cloudtrail#InsightsMetricValues", + "traits": { + "smithy.api#documentation": "

List of values representing the API call rate or error rate at each timestamp. The number of values is equal to the number of timestamps.

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

Only returned if the full results could not be returned in a single query. You can set the NextToken parameter \n in the next request to this value to continue retrieval.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudtrail#ListPublicKeys": { "type": "operation", "input": { @@ -8883,6 +9119,12 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.cloudtrail#Timestamps": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#Date" + } + }, "com.amazonaws.cloudtrail#Trail": { "type": "structure", "members": { @@ -9297,7 +9539,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.

\n

For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management, data, or Insights events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.

\n

For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.

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

Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 7 and\n 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled.

\n

For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management or data events in your event data store. For more\n information about AdvancedEventSelectors, see AdvancedEventSelectors.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.

", "smithy.api#idempotent": {} } }, @@ -9619,7 +9861,7 @@ "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs are delivered. You must use a log\n group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

\n \n

Only the management account can configure a CloudWatch Logs log group for an organization trail.

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

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that\n represents the log group to which CloudTrail logs are delivered. You must use a log\n group that exists in your account.

\n

Not required unless you specify CloudWatchLogsRoleArn.

" } }, "CloudWatchLogsRoleArn": { diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 72f30691971..e2abf81b1f4 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -14670,7 +14670,7 @@ "Filters": { "target": "com.amazonaws.connect#Filters", "traits": { - "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter up to the following limits:

\n \n

Metric data is retrieved only for the resources associated with the queues or routing\n profiles, and by any channels included in the filter. (You cannot filter by both queue AND\n routing profile.) You can include both resource IDs and resource ARNs in the same request.

\n

When using RoutingStepExpression, you need to pass exactly one\n QueueId.

\n

Currently tagging is only supported on the resources that are passed in the filter.

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

The filters to apply to returned metrics. You can filter up to the following limits:

\n \n

Metric data is retrieved only for the resources associated with the queues or routing\n profiles, and by any channels included in the filter. (You cannot filter by both queue AND\n routing profile.) You can include both resource IDs and resource ARNs in the same request.

\n

When using the RoutingStepExpression filter, you need to pass exactly one\n QueueId. The filter is also case sensitive so when using the\n RoutingStepExpression filter, grouping by ROUTING_STEP_EXPRESSION is\n required.

\n

Currently tagging is only supported on the resources that are passed in the filter.

", "smithy.api#required": {} } }, @@ -15215,7 +15215,7 @@ "Filters": { "target": "com.amazonaws.connect#FiltersV2List", "traits": { - "smithy.api#documentation": "

The filters to apply to returned metrics. You can filter on the following resources:

\n \n

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy\n groups.

\n

To filter by phone number, see Create a historical\n metrics report in the Amazon Connect Administrator's\n Guide.

\n

Note the following limits:

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

The filters to apply to returned metrics. You can filter on the following resources:

\n \n

At least one filter must be passed from queues, routing profiles, agents, or user hierarchy\n groups.

\n

To filter by phone number, see Create a historical\n metrics report in the Amazon Connect Administrator's\n Guide.

\n

Note the following limits:

\n ", "smithy.api#required": {} } }, @@ -15228,7 +15228,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n
\n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n
\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

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

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n
\n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype

\n \n

Feature is a valid filter but not a valid grouping.

\n
\n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n
\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype

\n
\n
", "smithy.api#required": {} } }, @@ -15547,7 +15547,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group.

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

The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15647,7 +15647,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 2 + "max": 3 } } }, @@ -22422,7 +22422,7 @@ "AllowedMonitorCapabilities": { "target": "com.amazonaws.connect#AllowedMonitorCapabilities", "traits": { - "smithy.api#documentation": "

Specify which monitoring actions the user is allowed to take. For example, whether the user\n is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.

" + "smithy.api#documentation": "

Specify which monitoring actions the user is allowed to take. For example, whether the user\n is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if\n barge is enabled.

" } }, "ClientToken": { @@ -35883,7 +35883,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.

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

The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/drs.json b/codegen/sdk-codegen/aws-models/drs.json index 901b8e58a31..37b16ea945a 100644 --- a/codegen/sdk-codegen/aws-models/drs.json +++ b/codegen/sdk-codegen/aws-models/drs.json @@ -1525,7 +1525,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Job log items to retrieve.

" } }, @@ -1604,7 +1603,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Jobs to retrieve.

" } }, @@ -1724,7 +1722,6 @@ "maxResults": { "target": "com.amazonaws.drs#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum results to be returned in DescribeLaunchConfigurationTemplates.

" } }, @@ -1813,7 +1810,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Recovery Instances to retrieve.

" } }, @@ -1928,7 +1924,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Recovery Snapshots to retrieve.

" } }, @@ -2030,7 +2025,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Replication Configuration Templates to retrieve.

" } }, @@ -2109,7 +2103,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Source Networks to retrieve.

" } }, @@ -2232,7 +2225,6 @@ "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum number of Source Servers to retrieve.

" } }, @@ -4491,10 +4483,7 @@ } }, "order": { - "target": "com.amazonaws.drs#LaunchActionOrder", - "traits": { - "smithy.api#default": 0 - } + "target": "com.amazonaws.drs#LaunchActionOrder" }, "actionVersion": { "target": "com.amazonaws.drs#LaunchActionVersion" @@ -4595,7 +4584,6 @@ "com.amazonaws.drs#LaunchActionOrder": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Launch action order.

", "smithy.api#range": { "min": 2, @@ -5226,7 +5214,6 @@ "maxResults": { "target": "com.amazonaws.drs#MaxResultsReplicatingSourceServers", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of extensible source servers to retrieve.

" } }, @@ -5314,7 +5301,6 @@ "maxResults": { "target": "com.amazonaws.drs#MaxResultsType", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

Maximum amount of items to return when listing resource launch actions.

" } }, @@ -5396,6 +5382,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of staging Accounts to retrieve.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { @@ -5491,7 +5478,6 @@ "com.amazonaws.drs#MaxResultsReplicatingSourceServers": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 300 @@ -5501,7 +5487,6 @@ "com.amazonaws.drs#MaxResultsType": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1, "max": 1000 @@ -5607,7 +5592,6 @@ "interval": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

How often, in the chosen units, a snapshot should be taken.

", "smithy.api#required": {} } @@ -5615,7 +5599,6 @@ "retentionDuration": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { - "smithy.api#default": 0, "smithy.api#documentation": "

The duration to retain a snapshot for, in the chosen units.

", "smithy.api#required": {} } @@ -5802,7 +5785,6 @@ "order": { "target": "com.amazonaws.drs#LaunchActionOrder", "traits": { - "smithy.api#default": 0, "smithy.api#required": {} } }, @@ -5889,10 +5871,7 @@ } }, "order": { - "target": "com.amazonaws.drs#LaunchActionOrder", - "traits": { - "smithy.api#default": 0 - } + "target": "com.amazonaws.drs#LaunchActionOrder" }, "actionVersion": { "target": "com.amazonaws.drs#LaunchActionVersion" @@ -8573,7 +8552,6 @@ "com.amazonaws.drs#StrictlyPositiveInteger": { "type": "integer", "traits": { - "smithy.api#default": 0, "smithy.api#range": { "min": 1 } diff --git a/codegen/sdk-codegen/aws-models/firehose.json b/codegen/sdk-codegen/aws-models/firehose.json index 5a4047ef67b..7243c29353e 100644 --- a/codegen/sdk-codegen/aws-models/firehose.json +++ b/codegen/sdk-codegen/aws-models/firehose.json @@ -1030,6 +1030,12 @@ }, "MSKSourceConfiguration": { "target": "com.amazonaws.firehose#MSKSourceConfiguration" + }, + "SnowflakeDestinationConfiguration": { + "target": "com.amazonaws.firehose#SnowflakeDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

Configure Snowflake destination

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

Describes the specified HTTP endpoint destination.

" } }, + "SnowflakeDestinationDescription": { + "target": "com.amazonaws.firehose#SnowflakeDestinationDescription", + "traits": { + "smithy.api#documentation": "

Optional description for the destination

" + } + }, "AmazonOpenSearchServerlessDestinationDescription": { "target": "com.amazonaws.firehose#AmazonOpenSearchServerlessDestinationDescription", "traits": { @@ -5784,6 +5796,530 @@ } } }, + "com.amazonaws.firehose#SnowflakeAccountUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 24, + "max": 2048 + }, + "smithy.api#pattern": "^.+?\\.snowflakecomputing\\.com$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeContentColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeDataLoadingOption": { + "type": "enum", + "members": { + "JSON_MAPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON_MAPPING" + } + }, + "VARIANT_CONTENT_MAPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARIANT_CONTENT_MAPPING" + } + }, + "VARIANT_CONTENT_AND_METADATA_MAPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARIANT_CONTENT_AND_METADATA_MAPPING" + } + } + } + }, + "com.amazonaws.firehose#SnowflakeDatabase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeDestinationConfiguration": { + "type": "structure", + "members": { + "AccountUrl": { + "target": "com.amazonaws.firehose#SnowflakeAccountUrl", + "traits": { + "smithy.api#documentation": "

URL for accessing your Snowflake account. This URL must include your account identifier. \n Note that the protocol (https://) and port number are optional.

", + "smithy.api#required": {} + } + }, + "PrivateKey": { + "target": "com.amazonaws.firehose#SnowflakePrivateKey", + "traits": { + "smithy.api#documentation": "

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

", + "smithy.api#required": {} + } + }, + "KeyPassphrase": { + "target": "com.amazonaws.firehose#SnowflakeKeyPassphrase", + "traits": { + "smithy.api#documentation": "

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

" + } + }, + "User": { + "target": "com.amazonaws.firehose#SnowflakeUser", + "traits": { + "smithy.api#documentation": "

User login name for the Snowflake account.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.firehose#SnowflakeDatabase", + "traits": { + "smithy.api#documentation": "

All data in Snowflake is maintained in databases.

", + "smithy.api#required": {} + } + }, + "Schema": { + "target": "com.amazonaws.firehose#SnowflakeSchema", + "traits": { + "smithy.api#documentation": "

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

", + "smithy.api#required": {} + } + }, + "Table": { + "target": "com.amazonaws.firehose#SnowflakeTable", + "traits": { + "smithy.api#documentation": "

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

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

Optionally configure a Snowflake role. Otherwise the default user role will be used.

" + } + }, + "DataLoadingOption": { + "target": "com.amazonaws.firehose#SnowflakeDataLoadingOption", + "traits": { + "smithy.api#documentation": "

Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

" + } + }, + "MetaDataColumnName": { + "target": "com.amazonaws.firehose#SnowflakeMetaDataColumnName", + "traits": { + "smithy.api#documentation": "

The name of the record metadata column

" + } + }, + "ContentColumnName": { + "target": "com.amazonaws.firehose#SnowflakeContentColumnName", + "traits": { + "smithy.api#documentation": "

The name of the record content column

" + } + }, + "SnowflakeVpcConfiguration": { + "target": "com.amazonaws.firehose#SnowflakeVpcConfiguration", + "traits": { + "smithy.api#documentation": "

The VPCE ID for Firehose to privately connect with Snowflake. The ID format is\n com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake\n

" + } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Snowflake role

", + "smithy.api#required": {} + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#SnowflakeRetryOptions", + "traits": { + "smithy.api#documentation": "

The time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.

" + } + }, + "S3BackupMode": { + "target": "com.amazonaws.firehose#SnowflakeS3BackupMode", + "traits": { + "smithy.api#documentation": "

Choose an S3 backup mode

" + } + }, + "S3Configuration": { + "target": "com.amazonaws.firehose#S3DestinationConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configure Snowflake destination

" + } + }, + "com.amazonaws.firehose#SnowflakeDestinationDescription": { + "type": "structure", + "members": { + "AccountUrl": { + "target": "com.amazonaws.firehose#SnowflakeAccountUrl", + "traits": { + "smithy.api#documentation": "

URL for accessing your Snowflake account. This URL must include your account identifier. \n Note that the protocol (https://) and port number are optional.

" + } + }, + "User": { + "target": "com.amazonaws.firehose#SnowflakeUser", + "traits": { + "smithy.api#documentation": "

User login name for the Snowflake account.

" + } + }, + "Database": { + "target": "com.amazonaws.firehose#SnowflakeDatabase", + "traits": { + "smithy.api#documentation": "

All data in Snowflake is maintained in databases.

" + } + }, + "Schema": { + "target": "com.amazonaws.firehose#SnowflakeSchema", + "traits": { + "smithy.api#documentation": "

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

" + } + }, + "Table": { + "target": "com.amazonaws.firehose#SnowflakeTable", + "traits": { + "smithy.api#documentation": "

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

" + } + }, + "SnowflakeRoleConfiguration": { + "target": "com.amazonaws.firehose#SnowflakeRoleConfiguration", + "traits": { + "smithy.api#documentation": "

Optionally configure a Snowflake role. Otherwise the default user role will be used.

" + } + }, + "DataLoadingOption": { + "target": "com.amazonaws.firehose#SnowflakeDataLoadingOption", + "traits": { + "smithy.api#documentation": "

Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

" + } + }, + "MetaDataColumnName": { + "target": "com.amazonaws.firehose#SnowflakeMetaDataColumnName", + "traits": { + "smithy.api#documentation": "

The name of the record metadata column

" + } + }, + "ContentColumnName": { + "target": "com.amazonaws.firehose#SnowflakeContentColumnName", + "traits": { + "smithy.api#documentation": "

The name of the record content column

" + } + }, + "SnowflakeVpcConfiguration": { + "target": "com.amazonaws.firehose#SnowflakeVpcConfiguration", + "traits": { + "smithy.api#documentation": "

The VPCE ID for Firehose to privately connect with Snowflake. The ID format is\n com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake\n

" + } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Snowflake role

" + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#SnowflakeRetryOptions", + "traits": { + "smithy.api#documentation": "

The time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.

" + } + }, + "S3BackupMode": { + "target": "com.amazonaws.firehose#SnowflakeS3BackupMode", + "traits": { + "smithy.api#documentation": "

Choose an S3 backup mode

" + } + }, + "S3DestinationDescription": { + "target": "com.amazonaws.firehose#S3DestinationDescription" + } + }, + "traits": { + "smithy.api#documentation": "

Optional Snowflake destination description

" + } + }, + "com.amazonaws.firehose#SnowflakeDestinationUpdate": { + "type": "structure", + "members": { + "AccountUrl": { + "target": "com.amazonaws.firehose#SnowflakeAccountUrl", + "traits": { + "smithy.api#documentation": "

URL for accessing your Snowflake account. This URL must include your account identifier. \n Note that the protocol (https://) and port number are optional.

" + } + }, + "PrivateKey": { + "target": "com.amazonaws.firehose#SnowflakePrivateKey", + "traits": { + "smithy.api#documentation": "

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

" + } + }, + "KeyPassphrase": { + "target": "com.amazonaws.firehose#SnowflakeKeyPassphrase", + "traits": { + "smithy.api#documentation": "

Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.

" + } + }, + "User": { + "target": "com.amazonaws.firehose#SnowflakeUser", + "traits": { + "smithy.api#documentation": "

User login name for the Snowflake account.

" + } + }, + "Database": { + "target": "com.amazonaws.firehose#SnowflakeDatabase", + "traits": { + "smithy.api#documentation": "

All data in Snowflake is maintained in databases.

" + } + }, + "Schema": { + "target": "com.amazonaws.firehose#SnowflakeSchema", + "traits": { + "smithy.api#documentation": "

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

" + } + }, + "Table": { + "target": "com.amazonaws.firehose#SnowflakeTable", + "traits": { + "smithy.api#documentation": "

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

" + } + }, + "SnowflakeRoleConfiguration": { + "target": "com.amazonaws.firehose#SnowflakeRoleConfiguration", + "traits": { + "smithy.api#documentation": "

Optionally configure a Snowflake role. Otherwise the default user role will be used.

" + } + }, + "DataLoadingOption": { + "target": "com.amazonaws.firehose#SnowflakeDataLoadingOption", + "traits": { + "smithy.api#documentation": "

JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

" + } + }, + "MetaDataColumnName": { + "target": "com.amazonaws.firehose#SnowflakeMetaDataColumnName", + "traits": { + "smithy.api#documentation": "

The name of the record metadata column

" + } + }, + "ContentColumnName": { + "target": "com.amazonaws.firehose#SnowflakeContentColumnName", + "traits": { + "smithy.api#documentation": "

The name of the content metadata column

" + } + }, + "CloudWatchLoggingOptions": { + "target": "com.amazonaws.firehose#CloudWatchLoggingOptions" + }, + "ProcessingConfiguration": { + "target": "com.amazonaws.firehose#ProcessingConfiguration" + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Snowflake role

" + } + }, + "RetryOptions": { + "target": "com.amazonaws.firehose#SnowflakeRetryOptions", + "traits": { + "smithy.api#documentation": "

Specify how long Kinesis Data Firehose retries sending data to the New Relic HTTP endpoint.\n \n After sending data, Kinesis Data Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Kinesis Data Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Kinesis Data Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket.\n \n Every time that Kinesis Data Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint.\n \n Even if the retry duration expires, Kinesis Data Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Kinesis Data Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired.\n \n If you don't want Kinesis Data Firehose to retry sending data, set this value to 0.

" + } + }, + "S3BackupMode": { + "target": "com.amazonaws.firehose#SnowflakeS3BackupMode", + "traits": { + "smithy.api#documentation": "

Choose an S3 backup mode

" + } + }, + "S3Update": { + "target": "com.amazonaws.firehose#S3DestinationUpdate" + } + }, + "traits": { + "smithy.api#documentation": "

Update to configuration settings

" + } + }, + "com.amazonaws.firehose#SnowflakeKeyPassphrase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeMetaDataColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakePrivateKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 256, + "max": 4096 + }, + "smithy.api#pattern": "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakePrivateLinkVpceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 47, + "max": 255 + }, + "smithy.api#pattern": "^([a-zA-Z0-9\\-\\_]+\\.){2,3}vpce\\.[a-zA-Z0-9\\-]*\\.vpce-svc\\-[a-zA-Z0-9\\-]{17}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeRetryDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 7200 + } + } + }, + "com.amazonaws.firehose#SnowflakeRetryOptions": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.firehose#SnowflakeRetryDurationInSeconds", + "traits": { + "smithy.api#documentation": "

the time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.

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

Specify how long Kinesis Data Firehose retries sending data to the New Relic HTTP endpoint.\n \n After sending data, Kinesis Data Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Kinesis Data Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Kinesis Data Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket.\n \n Every time that Kinesis Data Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint.\n \n Even if the retry duration expires, Kinesis Data Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Kinesis Data Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired.\n \n If you don't want Kinesis Data Firehose to retry sending data, set this value to 0.

" + } + }, + "com.amazonaws.firehose#SnowflakeRole": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeRoleConfiguration": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Enable Snowflake role

" + } + }, + "SnowflakeRole": { + "target": "com.amazonaws.firehose#SnowflakeRole", + "traits": { + "smithy.api#documentation": "

The Snowflake role you wish to configure

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

Optionally configure a Snowflake role. Otherwise the default user role will be used.

" + } + }, + "com.amazonaws.firehose#SnowflakeS3BackupMode": { + "type": "enum", + "members": { + "FailedDataOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FailedDataOnly" + } + }, + "AllData": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AllData" + } + } + } + }, + "com.amazonaws.firehose#SnowflakeSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeTable": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.firehose#SnowflakeVpcConfiguration": { + "type": "structure", + "members": { + "PrivateLinkVpceId": { + "target": "com.amazonaws.firehose#SnowflakePrivateLinkVpceId", + "traits": { + "smithy.api#documentation": "

The VPCE ID for Firehose to privately connect with Snowflake. The ID format is\n com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake\n

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

Configure a Snowflake VPC

" + } + }, "com.amazonaws.firehose#SourceDescription": { "type": "structure", "members": { @@ -6493,6 +7029,12 @@ "traits": { "smithy.api#documentation": "

Describes an update for a destination in the Serverless offering for Amazon OpenSearch\n Service.

" } + }, + "SnowflakeDestinationUpdate": { + "target": "com.amazonaws.firehose#SnowflakeDestinationUpdate", + "traits": { + "smithy.api#documentation": "

Update to the Snowflake destination condiguration settings

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.json b/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.json index e6365139bf6..d5b49fa58a1 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.json +++ b/codegen/sdk-codegen/aws-models/sagemaker-featurestore-runtime.json @@ -823,7 +823,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 10 + "max": 100 } } }, @@ -953,7 +953,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Record from a FeatureGroup in the\n OnlineStore. Feature Store supports both SoftDelete and\n HardDelete. For SoftDelete (default), feature columns are set\n to null and the record is no longer retrievable by GetRecord or\n BatchGetRecord. For HardDelete, the complete\n Record is removed from the OnlineStore. In both cases, Feature\n Store appends the deleted record marker to the OfflineStore with feature\n values set to null, is_deleted value set to True,\n and EventTime set to the delete input EventTime.

\n

Note that the EventTime specified in DeleteRecord should be\n set later than the EventTime of the existing record in the\n OnlineStore for that RecordIdentifer. If it is not, the\n deletion does not occur:

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

Deletes a Record from a FeatureGroup in the\n OnlineStore. Feature Store supports both SoftDelete and\n HardDelete. For SoftDelete (default), feature columns are set\n to null and the record is no longer retrievable by GetRecord or\n BatchGetRecord. For HardDelete, the complete\n Record is removed from the OnlineStore. In both cases, Feature\n Store appends the deleted record marker to the OfflineStore. The deleted\n record marker is a record with the same RecordIdentifer as the original, but\n with is_deleted value set to True, EventTime set to\n the delete input EventTime, and other feature values set to\n null.

\n

Note that the EventTime specified in DeleteRecord should be\n set later than the EventTime of the existing record in the\n OnlineStore for that RecordIdentifer. If it is not, the\n deletion does not occur:

\n \n

When a record is deleted from the OnlineStore, the deleted record marker is\n appended to the OfflineStore. If you have the Iceberg table format enabled for\n your OfflineStore, you can remove all history of a record from the\n OfflineStore using Amazon Athena or Apache Spark. For information on how to\n hard delete a record from the OfflineStore with the Iceberg table format\n enabled, see Delete records from the offline store.

", "smithy.api#http": { "method": "DELETE", "uri": "/FeatureGroup/{FeatureGroupName}",